Skip to content

Add license check to CI #98

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
clangenb merged 6 commits into from
Sep 28, 2022
Merged

Add license check to CI #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f90707d
Add step to add cargo-about
Niederb Sep 28, 2022
98ac38a
Add actual license check
Niederb Sep 28, 2022
a4d2c15
Archive the license file
Niederb Sep 28, 2022
5d5996b
Check if the build fails if a license is missing
Niederb Sep 28, 2022
3cb96d7
Update license check config
Niederb Sep 28, 2022
917dd4f
Fix name in license template
Niederb Sep 28, 2022
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
15 changes: 15 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,18 @@ jobs:

- name: ${{ matrix.check }}
run: ${{ matrix.check }}

- name: Install cargo-about
uses: baptiste0928/cargo-install@v1
with:
crate: cargo-about
version: "0.5"

- name: Run license check
run: cargo about generate about.hbs > license.html

- name: Archive license file
uses: actions/upload-artifact@v3
with:
name: license
path: license.html
70 changes: 70 additions & 0 deletions about.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<html>

<head>
<style>
@media (prefers-color-scheme: dark) {
body {
background: #333;
color: white;
}
a {
color: skyblue;
}
}
.container {
font-family: sans-serif;
max-width: 800px;
margin: 0 auto;
}
.intro {
text-align: center;
}
.licenses-list {
list-style-type: none;
margin: 0;
padding: 0;
}
.license-used-by {
margin-top: -10px;
}
.license-text {
max-height: 200px;
overflow-y: scroll;
white-space: pre-wrap;
}
</style>
</head>

<body>
<main class="container">
<div class="intro">
<h1>Third Party Licenses</h1>
<p>This page lists the licenses of the projects used in 'Integritee Networks Pallets' repository.</p>
</div>

<h2>Overview of licenses:</h2>
<ul class="licenses-overview">
{{#each overview}}
<li><a href="#{{id}}">{{name}}</a> ({{count}})</li>
{{/each}}
</ul>

<h2>All license text:</h2>
<ul class="licenses-list">
{{#each licenses}}
<li class="license">
<h3 id="{{id}}">{{name}}</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
{{#each used_by}}
<li><a href="{{#if crate.repository}} {{crate.repository}} {{else}} https://crates.io/crates/{{crate.name}} {{/if}}">{{crate.name}} {{crate.version}}</a></li>
{{/each}}
</ul>
<pre class="license-text">{{text}}</pre>
</li>
{{/each}}
</ul>
</main>
</body>

</html>
16 changes: 16 additions & 0 deletions about.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
accepted = [
"Apache-2.0",
"MIT",
"BSD-2-Clause",
"CC0-1.0",
"BSD-3-Clause",
"MPL-2.0",
"ISC",
"OpenSSL",
"Unicode-DFS-2016"
]
ignore-dev-dependencies = true
ignore-build-dependencies = true
workarounds = [
"ring",
]