From 43bd643263f2a557a37e023e538ab9f83dce92a6 Mon Sep 17 00:00:00 2001 From: "max.mehl" Date: Tue, 5 May 2020 15:06:11 +0200 Subject: [PATCH] update documentation with correct args syntax --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f844ce..01efda3 100644 --- a/README.md +++ b/README.md @@ -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.