Repository navigation
docs: align release guide with validated App workflow - #27
Merged
Merged
Conversation
There was a problem hiding this comment.
Approved. No blocking findings.
Advisory (P2/P3, or P1 past the round budget). These do not block approval:
- README.md: [P3] This line claims both paths run checks +
build:verify. True for CI only: the tag-push path runsbuild:verifyin the workflow (release.yml:69-72), but if the user pushes the tag before CI has finished, nothing verifies the packed package locally as the sentence implies. More importantly, the tag-push path never bumpspackage.jsonitself — it publishes whatever version the PR merged. A trailing note on the tag path ("push the tag only after the version-bump PR is merged; CI builds/verifies the tagged commit before publishing") would remove the ambiguity. - README.md: [P3] Hidden coupling the old text surfaced and this rewrite drops: the dispatch path pushes the version commit and tag as
seankoji-com-ci[bot], andrelease.yml:30skips the tag-push run for that actor (github.actor != 'seankoji-com-ci[bot]') precisely because the dispatch run does the publishing. If the App identity or actor name ever changes, the tag push silently re-triggers a secondnpm publish. Worth one sentence so whoever touches the workflow knows why the actor check exists. - README.md: [P3] Missing prerequisite for reproducing this setup: the workflow needs
SEANKOJI_CI_APP_ID(repo variable) andSEANKOJI_CI_PRIVATE_KEY(secret) — gitpush --atomicuses the App token URL at release.yml:95, so without them the job dies at token generation. Name the two configuration items alongside theRELEASE_PATreference that was just removed.
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.
The release guide still described a release PR and optional
RELEASE_PAT, although the workflow now validates the package and uses the CI GitHub App to push the version commit and tag atomically. Update the README to describe that flow and the existing npm OIDC publishing path.Validation: lint, typecheck, 91 tests with coverage, and build/package verification pass on the reviewed head. This changes only the README; no release was run.