Skip to content

Commit

Permalink
Merge pull request #38 from LeSpocky/yamllint
Browse files Browse the repository at this point in the history
Fix low hanging yamllint errors/warnings
  • Loading branch information
mxmehl authored Feb 12, 2025
2 parents 694eabb + af0fcda commit 211d270
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can include the following lines in your workflow .yml file to run the lint s
# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC0-1.0

---
name: REUSE Compliance Check

on: [push, pull_request]
Expand All @@ -42,33 +42,33 @@ jobs:
reuse-compliance-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4

- name: REUSE Compliance Check
uses: fsfe/reuse-action@v5
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v5
```
If you would like to run other subcommands, you could use the following snippet which outputs a the SPDX bill of materials:
```yml
- name: Checkout
uses: actions/checkout@v4
- name: REUSE SPDX SBOM
uses: fsfe/reuse-action@v5
with:
args: spdx
- name: Checkout
uses: actions/checkout@v4
- name: REUSE SPDX SBOM
uses: fsfe/reuse-action@v5
with:
args: spdx
```
In the same fashion, it is possible to add optional arguments like `--include-submodules`:

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


Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SPDX-FileCopyrightText: 2020 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

---
name: 'REUSE Compliance Check'
description: "Check your project's REUSE compliance for clear and simple licensing and copyright!"
author: 'Free Software Foundation Europe (FSFE)'
Expand Down

0 comments on commit 211d270

Please sign in to comment.