Skip to content

Chore: [AEA-0000] - Publish release notes to gh pages #57

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

Open
anthony-nhs wants to merge 3 commits into
base: main
Choose a base branch
from
+42 −1
Open

Chore: [AEA-0000] - Publish release notes to gh pages #57

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fbf30b
add release notes to github pages
anthony-nhs Feb 4, 2026
41b3676
force add
anthony-nhs Feb 4, 2026
daabbba
fix extra bits
anthony-nhs Feb 4, 2026
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
43 changes: 42 additions & 1 deletion .github/workflows/tag-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,11 +352,52 @@ jobs:
id: ${{ steps.get_release.outputs.id }}
body: |
## Info
[See code diff](${{ github.event.compare }})
[Release workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - Workflow ID: ${{ github.run_id }}

It was initialized by [${{ github.event.sender.login }}](${{ github.event.sender.html_url }})

- name: Checkout gh-pages branch
if: ${{ !inputs.dry_run }}
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
repository: ${{ github.repository }}
ref: gh-pages
path: gh-pages

- name: Publish release notes to gh-pages
if: ${{ !inputs.dry_run }}
working-directory: gh-pages
env:
RELEASE_ID: ${{ steps.get_release.outputs.id }}
VERSION_TAG: ${{ steps.output_version_tag.outputs.VERSION_TAG }}
GH_REPO: ${{ github.repository }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -euo pipefail
notes_dir="release_notes"
mkdir -p "$notes_dir"
note_file="$notes_dir/${VERSION_TAG}.md"

gh api "/repos/${GH_REPO}/releases/${RELEASE_ID}" | jq -r '.body // ""' > "$note_file"

if [ ! -s "$note_file" ]; then
echo "Release notes are empty; skipping gh-pages update."
exit 0
fi

git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

git add -f "$note_file"
if git diff --cached --quiet; then
echo "No changes detected in release notes; skipping commit."
exit 0
fi

git commit -m "docs: add release notes for ${VERSION_TAG}"
parallel --retries 10 --delay 3 ::: "git pull --rebase && git push"

- name: Output Change Set Version
id: output_change_set_version
shell: bash
Expand Down