docs: DEVELOPMENT.md described a release architecture that does not exist - #250
Merged
Conversation
…xist
The quick reference said "After PR merge, release happens automatically". It does not.
Chasing that turned up that the whole release story in this file describes workflows
that were replaced:
claimed reality
--------------------------------------- --------------------------------------
Auto-Release workflow runs on main push no such workflow; only CI runs on push
Build and Release triggers on a new tag no such workflow; NOTHING triggers on a
tag push
Actions -> Build and Release not in the Actions list
two workflows, chained by a tag one workflow, Release, workflow_dispatch
Verified against .github/workflows rather than assumed: there are two files, CI
(pull_request, push) and Release (workflow_dispatch only).
This mattered more than a stale sentence. Anyone following section 6's "manual
release" procedure would create and push a tag expecting a build, get nothing, and be
left with a tag that has no release attached -- which then has to be deleted before
the real release can use that version.
WHAT CHANGED
- Section 5 now says plainly that merging releases nothing, and lists the six jobs the
single Release workflow does in one run, including that lint and test GATE it.
- The flow diagram redrawn with the manual step where it actually is.
- Section 6 rewritten around `gh workflow run release.yml`, with a "do not release by
pushing a tag" warning naming what goes wrong.
- Two post-release checks added, because both have failed silently before and neither
shows as a red run: that all three version files moved together (#197), and that the
update manifests name assets that exist (#86).
- Troubleshooting's "Release Not Triggering" replaced with "No Release Appeared",
which starts by asking whether it was run at all -- the previous version assumed an
automatic trigger that has never existed here.
- "Version Mismatch" now covers package-lock.json. Syncing only package.json is
exactly how the lock sat at 2.9.0 while package.json reached 2.13.0 (#197).
- The hotfix section's "Auto-release will create a patch version" corrected.
Documentation only. Same class as #206 and #207, found while checking that the
markdown left after deleting TODO.md was actually current.
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.
Documentation only. Found while checking that the markdown left after deleting
TODO.md(#240)was actually current — it wasn't.
The one line I was asked to fix, and what was behind it
The quick reference said "After PR merge, release happens automatically". It does not. Chasing
that turned up that the entire release story in this file describes workflows that were replaced:
mainpushRelease,workflow_dispatchonlyVerified against
.github/workflowsrather than assumed: two files,CI(pull_request,push)and
Release(workflow_dispatchonly).Why this was worse than a stale sentence
Anyone following section 6's "manual release" procedure would create and push a tag expecting a
build, get nothing, and be left with a tag that has no release attached — which then has to be
deleted before the real release can use that version.
I hit the live version of this today: releasing v2.14.0 required
gh workflow run release.ymlbyhand, exactly as
CLAUDE.mdsays and exactly as this file said it wouldn't.What changed
Releaseworkflow does in one run — including that lint and test gate it.gh workflow run release.yml, with a "do not release by pushinga tag" warning that names what goes wrong.
a red run:
package.jsonreached 2.13.0 for four releases);
while the release looks perfect).
whether it was run at all. The old version assumed an automatic trigger that has never existed
here.
package-lock.json. Syncing onlypackage.jsonis preciselyhow fix: keep package-lock.json in step with the version bump #197 happened.
Verification
main(e1d1367)..github/workflows/*.yml; the only remaining "Auto-Release" mention is a deliberate one sayingit does not exist.
npm run lintclean (no code touched).use rather than by reading.
Not verified
them. They do not mention the phantom workflows, but "does not contradict the workflow files" is
a weaker claim than "known to work".