Repository navigation
Take release notes from docs/changelog.md - #133
Merged
Merged
Conversation
scripts/changelog.py checks the layout, renames ## Unreleased to the new version on a release, and writes one version's notes. The seed holds v2.4.13 to v2.5.4.
The release job checks ## Unreleased before the bump, renames it to the new version in the release commit, and passes the section to gh release create. publish-release.yml refuses a tag with no section. release-testflight.yml sets the What to Test notes from the section and warns when an old tag has none. The new Changelog job checks every pull request. ci/testflight-notes.txt is gone.
AGENTS.md describes docs/changelog.md, the release steps that use it, the Changelog check and the required checks on main. pre-commit is installed as a uv tool, and the hook needs core.hooksPath unset.
37 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/changelog.mdis now the one source of release notes. This closes item 7.7 of #126, which was the last open item.docs/changelog.mdstarts with## Unreleased, then one section per version:## vX.Y.Z (build N), YYYY-MM-DD. It is seeded with v2.4.13 to v2.5.4, written for testers. A release PR adds "- " lines under## Unreleased.scripts/changelog.py: three subcommands, with 61 tests that were written first.check [--require-unreleased]checks the layout, the version order and the 4000-character TestFlight limit. It also refuses Markdown formatting in the notes.releaserenames## Unreleasedto the new version.noteswrites one section.bump-build-number.yml):## Unreleasedbefore the bump, releases the section, and commitsdocs/changelog.mdwith the version.release-testflight.yml: "What to Test" takes the same section.ci/testflight-notes.txtis deleted. An old tag with no section gets a warning, not a failure.publish-release.yml: the fallback for a tag pushed by hand takes the notes from the changelog at the tag. It refuses a version with no section.Changelogcheck: it runs on Linux, on every PR and on every label change. A PR withoutskip-releasefails when## Unreleasedis empty. A label change does not rerun the iOS tests.AGENTS.md: the changelog rules, and the required checks. The pre-commit setup is nowuv tool install pre-commit && pre-commit install, with thecore.hooksPathfix.After this merges,
Changelogbecomes a required check onmain.Verification
actionlint: no findings.uv run ruff format --check . && uv run ruff check . && uv run mypy && uv run pytest -rs: 134 passed, 0 skipped.pre-commit run --all-files: all 12 hooks pass.bump_version.py, thenchangelog.py release, thennotesgave## v2.5.5 (build 57)and the exact notes.check --require-unreleasedfails on the empty## Unreleased.Release
skip-release. CI, tooling and docs only.