Document the release process - #212
Open
sensei-hacker wants to merge 3 commits into
Open
Conversation
Adds RELEASING.md covering versioning (single source of truth in iNav.lua), what make dist / make dist-lua each build, how the CI and release workflows trigger, the release procedure, and troubleshooting for the two failure modes hit while shipping 2.4: tag not matching the workflow trigger, and tagging before the version bump landed.
|
You also might want to add mention that the two packages need to be documented in the release notes also... i.e. this was missing in the release notes
|
Added section for Release Notes to guide users on changes and compatibility.
Member
Author
Thanks. Do you think this is good?: |
Corrected grammatical errors in the release notes section.
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
2 participants
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
Adds
RELEASING.md, a maintainer-facing doc for the build/tag/publish process, and links it fromCONTRIBUTING.md. Nothing in the existing docs (docs/*.md, which is the public mkdocs user site, orCONTRIBUTING.md) covered this before.Written up after diagnosing why the
2.4release shipped with zero assets (see #211): the tag didn't match therelease.ymltrigger, the workflow never built the_lua.zipasset in the first place, and the version string wasn't bumped before tagging.RELEASING.mddocuments the corrected process plus a "Lessons from the 2.4 release" section so the same failure mode isn't rediscovered from scratch next time.Changes
RELEASING.md(new): versioning (single source of truth iniNav.lua), whatmake distvsmake dist-luaeach do and why both are needed, howci.yml/release.ymltrigger, step-by-step release procedure, troubleshooting (moving a tag via the API, the restricted-GITHUB_TOKENpush block).CONTRIBUTING.md: one-line pointer toRELEASING.md.Test plan