Add third-party licenses to the release artifacts

17cupsofcoffee · 17cupsofcoffee · commit 206c6d3b9bc3 · 2025-05-11T15:57:57.000+01:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -3,6 +3,7 @@ name: Release
 on:
   release:
     types: [published]
+  workflow_dispatch:
 
 jobs:
   release:
@@ -29,6 +30,11 @@ jobs:
       with:
         toolchain: stable
         target: ${{ matrix.target }}
+    - name: Document licenses
+      shell: bash
+      run: | 
+        cargo install --locked cargo-about
+        cargo about generate about.hbs -o licenses.html
     - name: Build
       shell: bash
       run: |
@@ -42,9 +48,15 @@ jobs:
           bin="./target/${{ matrix.target }}/release/livetagger"
         fi
 
-        7z a "livetagger-$tag-${{ matrix.target }}.zip" $bin
+        7z a "livetagger-$tag-${{ matrix.target }}.zip" $bin licenses.html
+    - name: Attach artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.target }}
+        path: livetagger*
     - name: Publish
       uses: softprops/action-gh-release@v2
+      if: github.event_name = "release"
       with:
         files: "livetagger*"
       env:
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,6 +2,7 @@
 name = "livetagger"
 version = "0.0.4"
 edition = "2024"
+license = "MIT"
 
 [workspace]
 resolver = "3"
diff --git a/about.hbs b/about.hbs
@@ -0,0 +1,71 @@
+<html>
+
+<head>
+    <title>Third Party Licenses</title>
+    <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 open-source libraries used in LiveTagger.</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,15 @@
+accepted = [
+    "MIT",
+    "Apache-2.0",
+    "Unicode-3.0"
+]
+
+targets = [
+    "x86_64-pc-windows-msvc",
+    "x86_64-apple-darwin",
+    "aarch64-apple-darwin",
+]
+
+private = { ignore = true }
+ignore-build-dependencies = true
+ignore-dev-dependencies = true
diff --git a/livemeta/Cargo.toml b/livemeta/Cargo.toml
@@ -2,6 +2,8 @@
 name = "livemeta"
 version = "0.1.0"
 edition = "2024"
+license = "MIT"
+publish = false
 
 [dependencies]
 thiserror = "2.0.12"
