Skip to content

test: guard release notes fallback behavior #136

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
X-PG13 merged 1 commit into from
May 29, 2026
Merged

test: guard release notes fallback behavior #136

Show file tree
Hide file tree
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
6 changes: 5 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,11 @@ jobs:
if [ -f "${NOTES_FILE}" ]; then
cp "${NOTES_FILE}" /tmp/release-notes.md
else
printf 'Release %s\n' "${TAG}" > /tmp/release-notes.md
{
printf 'Release %s\n\n' "${TAG}"
printf 'Release notes file missing: `%s`.\n' "${NOTES_FILE}"
printf 'Maintainers should add this file before publishing final release notes.\n'
} > /tmp/release-notes.md
fi

- name: Publish GitHub release
Expand Down
15 changes: 15 additions & 0 deletions tests/test_release_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,21 @@ def test_release_workflow_reports_failure_phases(self) -> None:
self.assertIn("Trigger artifact smoke", release_workflow)
self.assertIn("Publish GitHub Release", release_workflow)

def test_release_workflow_documents_release_notes_fallback(self) -> None:
release_workflow = _read_text(".github/workflows/release.yml")

self.assertIn('TAG="${GITHUB_REF_NAME}"', release_workflow)
self.assertIn('NOTES_FILE="docs/releases/${TAG}.md"', release_workflow)
self.assertIn('if [ -f "${NOTES_FILE}" ]; then', release_workflow)
self.assertIn('cp "${NOTES_FILE}" /tmp/release-notes.md', release_workflow)
self.assertIn("Release notes file missing:", release_workflow)
self.assertIn("printf 'Release notes file missing: `%s`.", release_workflow)
self.assertIn('"${NOTES_FILE}"', release_workflow)
self.assertIn(
"Maintainers should add this file before publishing final release notes.",
release_workflow,
)

def test_release_recovery_docs_include_quick_reference(self) -> None:
release_recovery = _read_text("docs/release-recovery.md")
release_recovery_zh = _read_text("docs/release-recovery.zh-CN.md")
Expand Down