ament_copyright gives "<unknown>" error

[AlexandruSopt]

Hello,

When I run the ament_copyright in a colcon test or even manualy inside a terminal in my package with " ament_copyright" I get a warning with no relevant text explanation:

2/9 Testing: copyright
2/9 Test: copyright
Command: "/usr/bin/python3" "-u" "/opt/ros/humble/share/ament_cmake_test/cmake/run_test.py" "/colcon_ws/build/my_package_name/test_results/my_package_name/copyright.xunit.xml" "--package-name" "my_package_name" "--output-file" "/colcon_ws/build/my_package_name/ament_copyright/copyright.txt" "--command" "/opt/ros/humble/bin/ament_copyright" "--xunit-file" "/colcon_ws/build/my_package_name/test_results/my_package_name/copyright.xunit.xml"
Directory: /colcon_ws/src/my_package_name
"copyright" start time: Mar 13 09:26 UTC
Output:
----------------------------------------------------------
-- run_test.py: invoking following command in '/colcon_ws/src/my_package_name':
 - /opt/ros/humble/bin/ament_copyright --xunit-file /colcon_ws/build/my_package_name/test_results/my_package_name/copyright.xunit.xml
CONTRIBUTING.md:  unknown
LICENSE:  unknown
2 errors, checked 6 files

NOTE: "unknown" above have less_than and greater_than characters before and after, but that caused it to disappear here at save.

I checked also the documentation for ament_copyright , but I found no relevant info about this.

LICENSE file and CONTRIBUTING.md file have:

• UTF-8 encoding
• End in LF
• do not have any special characters.

Thank you!

[MichaelOrlov]

@AlexandruSopt Can you please provide a minimum valuable reproducer?
We would need an example of the file on which you are trying to run copyright and the exact command that you are using.

[AlexandruSopt]

At first I was receiving warning from ament_copyright that there is no CONTRIBUTING.md file. I created the file with info:

CONTRIBUTING.md:

#Contributing to the package

Your contribution is welcomed, but first please discuss with package owner.

## 📜 Code of Conduct

Please use feature branches to modify this module.
Use relevant branch names. Ex: feature/AT****_My_Ticket_Details. Where **** is the ticket number
Use Pull request and by default have the merging done by squashing the commits.

...

And since I added this I get:

2/9 Testing: copyright
2/9 Test: copyright
Command: "/usr/bin/python3" "-u" "/opt/ros/humble/share/ament_cmake_test/cmake/run_test.py" "/__w/my_package_name/my_package_name/software-stack/build/my_package_name/test_results/my_package_name/copyright.xunit.xml" "--package-name" "my_package_name" "--output-file" "/__w/my_package_name/my_package_name/software-stack/build/my_package_name/ament_copyright/copyright.txt" "--command" "/opt/ros/humble/bin/ament_copyright" "--xunit-file" "/__w/my_package_name/my_package_name/software-stack/build/my_package_name/test_results/my_package_name/copyright.xunit.xml"
Directory: /__w/my_package_name/my_package_name/software-stack/src/my_package_name
"copyright" start time: Mar 31 07:35 UTC
Output:
----------------------------------------------------------
-- run_test.py: invoking following command in '/__w/my_package_name/my_package_name/software-stack/src/my_package_name':
 - /opt/ros/humble/bin/ament_copyright --xunit-file /__w/my_package_name/my_package_name/software-stack/build/my_package_name/test_results/my_package_name/copyright.xunit.xml
CONTRIBUTING.md: <unknown>
LICENSE: <unknown>
2 errors, checked 6 files
-- run_test.py: return code 1
-- run_test.py: verify result file '/__w/my_package_name/my_package_name/software-stack/build/my_package_name/test_results/my_package_name/copyright.xunit.xml'
<end of output>
Test time =   0.47 sec
----------------------------------------------------------
Test Failed.
"copyright" end time: Mar 31 07:35 UTC
"copyright" time elapsed: 00:00:00
----------------------------------------------------------

Similar to LICENSE.md

[MichaelOrlov]

@AlexandruSopt The expected workflow to run the copyright linter is follwing.

1. source /opt/ros/humble/setup.bash
2. ament_copyright --help

usage: ament_copyright [-h] [--exclude [filename ...]] [--add-missing COPYRIGHT_NAME LICENSE]
                       [--add-copyright-year [ADD_COPYRIGHT_YEAR ...]] [--list-copyright-names] [--list-licenses]
                       [--verbose] [--xunit-file XUNIT_FILE]
                       [paths ...]

Check code files for copyright and license information.

positional arguments:
  paths                 The files or directories to check. For directories files ending in '.c', '.cc', '.cpp', '.cxx',
                        '.h', '.hh', '.hpp', '.hxx', '.cmake', '.py' will be considered (except directories starting with
                        '.' or '_' and 'setup.py' files beside 'package.xml' files). (default: ['.'])

3. ament_copyright path/to/your/file/to/check

However, the problem likely is that ament_copyright is not meant to be running for *.md files.

[MichaelOrlov]

When I am running

ament_copyright /home/morlov/ros2_humble/src/ros2/rosbag2/CONTRIBUTING.md

I am getting the response

No repository roots and files found
No problems found, checked 0 files

However, if running it against some hpp file

ament_copyright /home/morlov/ros2_humble/src/ros2/rosbag2/rosbag2_transport/include/rosbag2_transport/recorder.hpp 

it is correctly checks and output

No problems found, checked 1 files