Skip to content

build: Update document generation script #160

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
XavierBerger merged 1 commit into from
Aug 13, 2026
Merged

build: Update document generation script #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions tools/update_documentation.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
#!/bin/bash
set -e

SCRIPT_DIR=$(dirname "$0")
pushd "${SCRIPT_DIR}/.." > /dev/null
git cliff | sed "s/#74 //" > docs/en/changelog.md

cleanup() {
git restore docs/en/changelog.md docs/fr/changelog.md 2>/dev/null || true
popd > /dev/null 2>&1 || true
}
trap cleanup EXIT

git cliff -l > docs/en/changelog.md

code docs/en/changelog.md

read -r -p "Ready to publish? [y/N]: " response
Expand All @@ -12,7 +21,4 @@ cp docs/en/changelog.md docs/fr/changelog.md
if [[ "$response" =~ ^[Yy]$ ]]; then
mkdocs gh-deploy
fi
git restore docs/en/changelog.md
git restore docs/fr/changelog.md

popd > /dev/null