Skip to content

Commit

Permalink
docs: Update examples to use v4 and include checksums
Browse files Browse the repository at this point in the history
Signed-off-by: Andy Scherzinger <[email protected]>
  • Loading branch information
AndyScherzinger committed Jul 4, 2024
1 parent 5c52285 commit 6d8ca1d
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,30 +36,34 @@ name: REUSE Compliance Check
on: [push, pull_request]

jobs:
test:
reuse-compliance-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7

- name: REUSE Compliance Check
uses: fsfe/reuse-action@v3
uses: fsfe/reuse-action@3ae3c6bdf1257ab19397fab11fd3312144692083 # v4.0.0
```
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@v4
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- name: REUSE SPDX SBOM
uses: fsfe/reuse-action@v3
uses: fsfe/reuse-action@3ae3c6bdf1257ab19397fab11fd3312144692083 # v4.0.0
with:
args: spdx
```
In the same fashion, it is possible to add optional arguments like `--include-submodules`:

```yml
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v3
uses: fsfe/reuse-action@3ae3c6bdf1257ab19397fab11fd3312144692083 # v4.0.0
with:
args: --include-submodules lint
```
Expand Down

0 comments on commit 6d8ca1d

Please sign in to comment.