docs(release): point skill at workflow-driven mechanism (gh workflow run release.yml)#28
Open
sanity wants to merge 1 commit into
Open
docs(release): point skill at workflow-driven mechanism (gh workflow run release.yml)#28sanity wants to merge 1 commit into
sanity wants to merge 1 commit into
Conversation
freenet-core's v0.2.58 release went through `gh workflow run release.yml` end-to-end (see freenet-core PRs #4082, #4114, #4115, #4118-4124, #4135, #4136). The canonical procedure now lives in freenet-core/docs/RELEASING.md. This skill previously instructed agents to run `scripts/release.sh --version X.Y.Z` and SSH into gateways manually. That path: - Still works as a fallback, but - Double-posts to Matrix/River if used while the workflow path is also in play (the workflow's Matrix announcement is deduped per-version via deterministic TXN_ID; the local script's matrix-commander post is not). This commit: - Replaces Step 4 with the `gh workflow run release.yml` invocation (both bare auto-bump form and explicit `--field version=X.Y.Z`). - Documents the prerequisite repo secrets and what each one's failure mode looks like. - Drops the per-step pipeline description that was bound to release.sh internals; refers readers to docs/RELEASING.md as the source of truth. - Calls out the legacy script + the env vars (`FREENET_RELEASE_SKIP_ANNOUNCEMENTS=1`, `FREENET_RELEASE_SKIP_GATEWAY_SSH=1`) for emergency use. - Rewrites Step 7 to note announcements are automatic, with a manual re-fire command if `release-announce.yml` fails. The verification steps (5, 6, 6.5, 8) are unchanged — those still apply, the artifact paths and smoke tests aren't affected. Tested manually for v0.2.58 (gateways converged, Matrix posted).
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
1 participant
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.
Problem
The
releaseskill instructs agents to runscripts/release.sh --version X.Y.Zand SSH into gateways manually. freenet-core's release pipeline was rewritten across PRs #4082, #4114, #4115, #4118-4124, #4135, and #4136 to be fully workflow-driven:gh workflow run release.ymltriggers the entire cascade including crates.io publish, tag push, cross-compile, gateway updates via HTTP webhooks, and Matrix/River announcements.v0.2.58 was the first release cut through this new path — both gateways converged automatically and Matrix posted automatically.
The canonical procedure now lives in freenet-core/docs/RELEASING.md.
This skill was still telling agents to use the old SSH-driven path, which:
Solution
Replace Step 4 (the release execution) with the
gh workflow runinvocation. Point readers atdocs/RELEASING.mdas the source of truth. Document the prerequisite repo secrets and per-secret failure modes.Rewrite Step 7 (Announcements) to note that announcements are automatic, with a
gh workflow run release-announce.ymlmanual re-fire command for failure recovery.Leave the verification steps (5, 6, 6.5, 8) untouched — they're path-agnostic.
Testing
The new procedure was validated end-to-end by cutting v0.2.58 via
gh workflow run release.yml. Both gateways converged, Matrix posted, the cascade auto-fired onrelease.published(becauseRELEASE_PATwas set per the new requirement documented in AGENTS.md).[AI-assisted - Claude]