Skip to content

Commit

Permalink
update documentation with correct args syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
mxmehl committed May 5, 2020
1 parent 6ae1b04 commit 43bd643
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Expand Up @@ -35,26 +35,39 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v2
- name: REUSE Compliance Check
uses: fsfe/reuse-action@master
uses: fsfe/reuse-action@v1
```

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

```yml
- uses: actions/checkout@v2
- name: REUSE Compliance Check
uses: fsfe/reuse-action@master
uses: fsfe/reuse-action@v1
with:
args: spdx
```

In the same fashion, it is possible to add optional arguments like `--include-submodules`:

```yml
- uses: actions/checkout@v2
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v1
with:
args: --include-submodules lint
```


## Inputs Description

| Name | Requirement | Default | Description |
| ------ | ----------- | ------- | ----------- |
| `args` | _required_ | `lint` | The subcommand for the REUSE helper tool. Read the [tool's documentation](https://reuse.readthedocs.io/) for all available subcommands. |


## License

This action itself is REUSE compliant, so copyright and licensing information is stored in every file. As of March 2020, all files are licensed under GPL-3.0-or-later.
Expand Down

0 comments on commit 43bd643

Please sign in to comment.