Merge pull request #240 from korpling/feature/update-licenses-on-release

Generate third party license file as pre-release hook
korpling · Jun 17, 2024 · 5753882 · 5753882
2 parents 2976717 + d04e582
commit 5753882
Show file tree

Hide file tree

Showing 4 changed files with 795 additions and 235 deletions.
diff --git a/README.md b/README.md
@@ -200,7 +200,7 @@ installed to perform a release. Execute the follwing `cargo` command once to
 install it.
 
 ```bash
-cargo install cargo-release
+cargo install cargo-release cargo-about
 ```
 
 To perform a release, switch to the main branch and execute:

diff --git a/about.hbs b/about.hbs
@@ -48,7 +48,7 @@
             <p>This page lists the licenses of the projects used in annatto.</p>
             <p>To re-generate this list, install the <a href="https://crates.io/crates/cargo-about">cargo-about</a>
                 Cargo plugin and run
-            <pre>cargo about generate about.hbs > third-party-licenses.html</pre>
+            <pre>cargo about generate about.hbs -o third-party-licenses.html</pre>
             </p>
         </div>
 

diff --git a/release.toml b/release.toml
@@ -1,3 +1,11 @@
+pre-release-hook = [
+  "cargo",
+  "about",
+  "generate",
+  "about.hbs",
+  "-o",
+  "third-party-licenses.html",
+]
 pre-release-replacements = [
   {file = "CHANGELOG.md", search = "## \\[Unreleased\\]", replace = "## [Unreleased]\n\n## [{{version}}] - {{date}}"},
   {file = "CITATION.cff", search = "^version: [0-9.]+", replace = "version: {{version}}"},