You struggle with how to properly do licensing and copyright in your project? REUSE helps you in three simple steps! Read more on reuse.software and run the short tutorial to learn how to make your licensing and copyright easy and clear.

This action allows users to check for compliance with the REUSE best practices if they prefer GitHub actions. It is one of many options for projects to include REUSE in their workflows. Please see the help for developers to get an overview.

This action runs the reuse lint command over your repository to check the following information:

• Is copyright and licensing information available for every single file?
• Do full license texts exist for all found license identifiers?
• Are there any other problems with detecting copyright and licensing information?

To make use of the other features the REUSE helper tool offers, for example adding comment headers semi-automatically and downloading license texts, please install the tool on your computer.

By default, you can include the following lines in your workflow .yml file to run the lint subcommand:

name: REUSE Compliance Check

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps: 
    - uses: actions/checkout@master
    - name: REUSE Compliance Check
      uses: fsfe/reuse-action@master

If you would like to run other subcommands, you could use the following snippet which outputs a the SPDX bill of materials:

    - name: REUSE Compliance Check
      uses: fsfe/reuse-action@master
      with:
        cmd: 'spdx'

Please note that due to Github restrictions it is not possible to pass extra arguments like --include-submodules to the cmd input.

This action itself is REUSE compliant, so copyright and licensing information is stored in every file or as close as possible to it. At the time of writing, all files are licensed under GPL-3.0-or-later, copyright Free Software Foundation Europe e.V..

Using the REUSE helper tool, you can run reuse spdx to get a full bill of materials.