Skip to content

ci: use explicit release notes for immutable releases #456

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
codeforester merged 2 commits into from
Oct 10, 2026
Merged

ci: use explicit release notes for immutable releases #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
483f98d
ci: use explicit release notes
codeforester Oct 10, 2026
5a1bce9
test: format release workflow assertion
codeforester Oct 10, 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
1 change: 0 additions & 1 deletion .github/workflows/package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,6 @@ jobs:
gh release create "$tag" "${assets[@]}" \
--repo "$GITHUB_REPOSITORY" \
--title "$tag" \
--generate-notes \
--notes "Published distributions and release metadata for $tag. See CHANGELOG.md for the reviewed release notes." \
|| create_status=$?

Expand Down
10 changes: 10 additions & 0 deletions tests/test_package_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ def test_package_workflow_does_not_replace_published_release_assets() -> None:
assert "--clobber" not in workflow


def test_package_workflow_uses_explicit_release_notes() -> None:
workflow = (Path(__file__).resolve().parents[1] / ".github/workflows/package.yml").read_text(encoding="utf-8")

assert "--generate-notes" not in workflow
assert (
'--notes "Published distributions and release metadata for $tag. See CHANGELOG.md for the reviewed release notes."'
in workflow
)


def test_package_workflow_gates_writes_on_release_provenance() -> None:
workflow = (Path(__file__).resolve().parents[1] / ".github/workflows/package.yml").read_text(encoding="utf-8")
jobs = yaml.safe_load(workflow)["jobs"]
Expand Down
Loading