Skip to content

ci: verify third-party licenses on PR and change to plaintext format from html third-party licenses #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2025
Merged

ci: verify third-party licenses on PR and change to plaintext format from html third-party licenses #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ee10d0
ci: verify third-party licenses on PR and change to plaintext format …
jeroenvervaeke Oct 3, 2025
aba4048
regenerate after changing template
jeroenvervaeke Oct 3, 2025
f610619
re-ran generate with cargo-about 0.8.2
jeroenvervaeke Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ env:
CARGO_INCREMENTAL: '1'
CARGO_DENY_VERSION: 0.18.4
CARGO_AUDIT_VERSION: 0.21.2
CARGO_ABOUT_VERSION: 0.8.2
'on':
push:
branches:
Expand Down Expand Up @@ -362,7 +363,7 @@ jobs:
uses: actions/cache@v4
with:
path: ~/.cargo/bin
key: ${{ runner.os }}-cargo-tools-deny-${{ env.CARGO_DENY_VERSION }}-audit-${{ env.CARGO_AUDIT_VERSION }}
key: ${{ runner.os }}-cargo-tools-deny-${{ env.CARGO_DENY_VERSION }}-audit-${{ env.CARGO_AUDIT_VERSION }}-about-${{ env.CARGO_ABOUT_VERSION }}
restore-keys: |
${{ runner.os }}-cargo-tools-

Expand All @@ -378,8 +379,27 @@ jobs:
cargo install --locked --version ${{ env.CARGO_AUDIT_VERSION }} cargo-audit
fi

- name: Install cargo-about
run: |
if ! command -v cargo-about &> /dev/null; then
cargo install --locked --version ${{ env.CARGO_ABOUT_VERSION }} cargo-about
fi

- name: Run cargo deny
run: cargo deny check

- name: Run cargo audit
run: cargo audit

- name: Verify LICENSE-3RD-PARTY.txt is up to date
run: |
cargo about generate --frozen about.hbs > LICENSE-3RD-PARTY-generated.txt
if ! diff -q LICENSE-3RD-PARTY.txt LICENSE-3RD-PARTY-generated.txt > /dev/null; then
echo "ERROR: LICENSE-3RD-PARTY.txt is not up to date!"
echo "Please run: cargo about generate about.hbs > LICENSE-3RD-PARTY.txt"
echo "Differences found:"
diff LICENSE-3RD-PARTY.txt LICENSE-3RD-PARTY-generated.txt || true
exit 1
fi
rm LICENSE-3RD-PARTY-generated.txt
echo "LICENSE-3RD-PARTY.txt is up to date"
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ dist
#Added by cargo

/target
Cargo.lock

*.node
.pnp.*
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ This verifies that all dependencies use acceptable licenses and checks for known
We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to generate our third-party licenses notice:

```sh
cargo about generate about.hbs > license.html
cargo about generate --frozen about.hbs > LICENSE-3RD-PARTY.txt
```

This generates an HTML file containing all third-party license information for our dependencies.
This generates the file containing all third-party license information for our dependencies.

## Submitting Your Changes

Expand Down
Loading