Skip to content

Commit af0fcda

Browse files
committed
readme: Fix yamllint warnings/errors in examples
This avoid copying this flaws from the examples to every user including this in his or her actions. After extracting from the code block to a separate file: % yamllint example1.yaml example1.yaml 1:81 error line too long (86 > 80 characters) (line-length) 5:1 warning missing document start "---" (document-start) 7:1 warning truthy value should be one of [false, true] (truthy) 16:5 error wrong indentation: expected 6 but found 4 (indentation) Ignoring the "line too long" and the "truthy value" issue, but "missing document start" and "wrong indentation" could be fixed easily.
1 parent b4e6e37 commit af0fcda

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can include the following lines in your workflow .yml file to run the lint s
3030
# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
3131
#
3232
# SPDX-License-Identifier: CC0-1.0
33-
33+
---
3434
name: REUSE Compliance Check
3535

3636
on: [push, pull_request]
@@ -42,33 +42,33 @@ jobs:
4242
reuse-compliance-check:
4343
runs-on: ubuntu-latest
4444
steps:
45-
- name: Checkout
46-
uses: actions/checkout@v4
45+
- name: Checkout
46+
uses: actions/checkout@v4
4747

48-
- name: REUSE Compliance Check
49-
uses: fsfe/reuse-action@v5
48+
- name: REUSE Compliance Check
49+
uses: fsfe/reuse-action@v5
5050
```
5151
5252
If you would like to run other subcommands, you could use the following snippet which outputs a the SPDX bill of materials:
5353
5454
```yml
55-
- name: Checkout
56-
uses: actions/checkout@v4
57-
- name: REUSE SPDX SBOM
58-
uses: fsfe/reuse-action@v5
59-
with:
60-
args: spdx
55+
- name: Checkout
56+
uses: actions/checkout@v4
57+
- name: REUSE SPDX SBOM
58+
uses: fsfe/reuse-action@v5
59+
with:
60+
args: spdx
6161
```
6262
6363
In the same fashion, it is possible to add optional arguments like `--include-submodules`:
6464

6565
```yml
66-
- name: Checkout
67-
uses: actions/checkout@v4
68-
- name: REUSE Compliance Check
69-
uses: fsfe/reuse-action@v5
70-
with:
71-
args: --include-submodules lint
66+
- name: Checkout
67+
uses: actions/checkout@v4
68+
- name: REUSE Compliance Check
69+
uses: fsfe/reuse-action@v5
70+
with:
71+
args: --include-submodules lint
7272
```
7373

7474

0 commit comments

Comments
 (0)