Repository navigation
Version releases with SemVer 0.x and a hand-written changelog - #70
Merged
Merged
Conversation
Releases use Semantic Versioning, 0.x while pre-alpha (a minor bump for features or project-breaking changes, a patch bump for fixes), with -alpha.N, -beta.N and -rc.N pre-releases. CHANGELOG.md (Keep a Changelog) is the user-facing list of changes; PROGRESS.md stays the development log. The Release workflow now rejects a tag whose version isn't X.Y.Z or a pre-release of it, or that has no CHANGELOG.md section. The draft release uses that section as its notes, followed by GitHub's generated list of pull requests, and marks pre-release versions as GitHub pre-releases. The section is extracted by tools/release/changelog-notes.sh, which lint now tests. docs/building.md describes the scheme and the release steps; CONTRIBUTING asks for a changelog line with user-visible changes. Closes #37
# Conflicts: # .github/workflows/ci.yml
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.
Closes #37.
Decisions
0.xwhile Device is pre-alpha.vX.Y.Z-alpha.N,-beta.Nor-rc.N, and published as GitHub pre-releases.CHANGELOG.mdin Keep a Changelog style. Release notes are the version's changelog section, followed by GitHub's generated list of pull requests.PROGRESS.mdstays the development log.Cargo.tomland moves the Unreleased entries under the new version. After it merges, the tag goes on that commit.Changes
CHANGELOG.md(new): explains the scheme and has an Unreleased section summarising what 0.1.0 will contain..github/workflows/release.yml, version job: a release tag now also has to beX.Y.Zor a pre-release of it, and must have a changelog section. Both are checked before anything builds..github/workflows/release.yml, release job: it sparse-checks-out the changelog and uses the section as--notes-filetogether with--generate-notes. A version with a-gets--prerelease.tools/release/changelog-notes.sh(new): extracts the section and fails on a missing or empty one.tools/release/test-changelog-notes.sh(new): five small cases, now run bylint:docs/building.mdgets a new "Versions and releases" section with the steps. CONTRIBUTING asks for a changelog line with user-visible changes, and the README status row mentions macOS signing.Testing
Run locally:
The release job itself only runs on a pushed
v*tag, so the first real run is the first release.No screenshots, because nothing in the app changes. No benchmarks, because no runtime code changes.
Generated by Claude Code