chore(license): create and check license file using cargo-about (#493)

kyu08 · web-flow · commit 3af5a7580537 · 2025-05-10T13:56:24.000Z
diff --git a/.github/workflows/check-license-file.yml b/.github/workflows/check-license-file.yml
@@ -0,0 +1,18 @@
+name: Check license file
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+
+jobs:
+  check-license-file:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Check
+        run: make update-license-file
+      - name: Check diff
+        run: |
+          git add .
+          git diff --cached --exit-code
diff --git a/CREDITS b/CREDITS
diff --git a/Makefile b/Makefile
@@ -1,9 +1,6 @@
+# Checks same as CI
 .PHONY: ci
-ci: # Checks same as CI
-	@make test-ci; \
-	make check; \
-	make fmt-check; \
-	make spell-check
+ci: test-ci check fmt-check detect-unused-dependencies update-license-file spell-check
 
 .PHONY: run
 run:
@@ -36,6 +33,12 @@ tool-detect-unused-dependencies:
 		cargo install cargo-machete; \
 	fi
 
+.PHONY: tool-update-license-file
+tool-update-license-file:
+	@if ! which cargo-about > /dev/null; then \
+		cargo install --locked cargo-about; \
+	fi
+
 .PHONY: test-ci # for CI
 test-ci:
 	RUST_BACKTRACE=full FZF_MAKE_IS_TESTING=true cargo test
@@ -78,6 +81,10 @@ spell-check: tool-spell-check
 detect-unused-dependencies: tool-detect-unused-dependencies
 	cargo machete
 
+.PHONY: update-license-file
+update-license-file: tool-update-license-file
+	cargo about generate about.hbs > license.html
+
 DEBUG_EXECUTABLE = ./target/debug/fzf-make
 TEST_DIR = ./test_data
 .PHONY: run-in-test-data
diff --git a/_typos.toml b/_typos.toml
@@ -2,4 +2,4 @@
 ratatui = "ratatui"
 
 [files]
-extend-exclude = ["doc/README-*.md"]
+extend-exclude = ["license.html"]
diff --git a/about.hbs b/about.hbs
@@ -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 fzf-make.</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>
diff --git a/about.toml b/about.toml
@@ -0,0 +1,11 @@
+accepted = [
+   "MIT",
+    "ISC",
+    "Apache-2.0",
+    "MPL-2.0",
+    "BSD-2-Clause",
+    "BSD-3-Clause",
+    "Unicode-DFS-2016",
+    "OpenSSL",
+]
+workarounds = ["ring"]
diff --git a/license.html b/license.html
