Add script to generate license dependencies as csv (#18411)

Co-authored-by: Joseph T. Lyons <JosephTLyons@gmail.com>
This commit is contained in:
Peter Tripp 2024-09-26 16:21:20 -04:00 committed by GitHub
parent e28496d4e2
commit 48c6eb9ac7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 35 additions and 2 deletions

2
.gitignore vendored
View file

@ -10,7 +10,7 @@
/crates/collab/seed.json
/crates/zed/resources/flatpak/flatpak-cargo-sources.json
/dev.zed.Zed*.json
/assets/*licenses.md
/assets/*licenses.*
**/venv
.build
*.wasm

View file

@ -4,6 +4,7 @@ set -euo pipefail
CARGO_ABOUT_VERSION="0.6.1"
OUTPUT_FILE="${1:-$(pwd)/assets/licenses.md}"
TEMPLATE_FILE="script/licenses/template.md.hbs"
> $OUTPUT_FILE
@ -23,7 +24,10 @@ else
fi
echo "Generating cargo licenses"
cargo about generate --fail -c script/licenses/zed-licenses.toml script/licenses/template.hbs.md >> $OUTPUT_FILE
cargo about generate \
--fail \
-c script/licenses/zed-licenses.toml \
"${TEMPLATE_FILE}" >> $OUTPUT_FILE
sed -i.bak 's/&quot;/"/g' $OUTPUT_FILE

23
script/generate-licenses-csv Executable file
View file

@ -0,0 +1,23 @@
#!/usr/bin/env bash
set -euo pipefail
CARGO_ABOUT_VERSION="0.6.1"
OUTPUT_FILE="${1:-$(pwd)/assets/licenses.csv}"
TEMPLATE_FILE="script/licenses/template.csv.hbs"
if ! cargo install --list | grep "cargo-about v$CARGO_ABOUT_VERSION" > /dev/null; then
echo "Installing cargo-about@$CARGO_ABOUT_VERSION..."
cargo install "cargo-about@$CARGO_ABOUT_VERSION"
else
echo "cargo-about@$CARGO_ABOUT_VERSION is already installed."
fi
echo "Generating cargo licenses"
cargo about generate \
--fail \
-c script/licenses/zed-licenses.toml \
script/licenses/template.csv.hbs \
| awk 'NR==1{print;next} NF{print | "sort"}' \
> $OUTPUT_FILE
echo "Completed. See $OUTPUT_FILE"

View file

@ -0,0 +1,6 @@
Crate Name,Crate Version,License,Url
{{#each licenses}}
{{#each used_by}}
{{crate.name}},{{crate.version}},{{../name}},{{#if crate.repository}}{{crate.repository}}{{else}}https://crates.io/crates/{{crate.name}}{{/if}}
{{/each}}
{{/each}}