Skip to content

docs: sync requirements and release playbook#24

Merged
steipete merged 1 commit into
mainfrom
fix/docs-release-current-state
Jul 2, 2026
Merged

docs: sync requirements and release playbook#24
steipete merged 1 commit into
mainfrom
fix/docs-release-current-state

Conversation

@steipete

@steipete steipete commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • match source-install documentation to the Go 1.25 minimum declared by go.mod
  • replace obsolete manual/source-only Homebrew steps with the current automated release/tap workflow and recovery path
  • restore the next-patch 0.4.2 - Unreleased changelog section after the verified 0.4.1 release

Root cause

The minimum Go version moved from 1.24 to 1.25 in a26e288863eef8c33614c89082aafed1e0a3674e, but three install/spec references remained on 1.24. The release workflow later took ownership of cross-platform archives, checksums, GitHub Release assets, and Homebrew dispatch/wait, while both release playbooks still described a manual source-tarball formula update.

Proof

  • pnpm check
  • pnpm docs:build; generated pages contain the corrected Go minimum and automated release flow
  • actionlint .github/workflows/*.yml
  • go mod verify
  • go mod tidy -diff
  • govulncheck ./...: no vulnerabilities found
  • autoreview: clean; no accepted/actionable findings
  • Public Model Identifier Gate: PASS; candidate diff and generated documentation introduce or change no model identifiers

Risk: low. Documentation and changelog only; no runtime, API, workflow, or dependency behavior changes. The rendered documentation is the affected artifact and built successfully.

@clawsweeper

clawsweeper Bot commented Jul 2, 2026

Copy link
Copy Markdown

ClawSweeper status: review started.

I am starting a fresh review of this pull request: docs: sync requirements and release playbook This is item 1/1 in the current shard. Shard 0/1.

This placeholder means the worker is alive and reading the current context. I will edit this same comment with the actual review when the claws are done clicking.

Crustacean status: shell secured, claws on keyboard, evidence pebbles being sorted.

@steipete
steipete merged commit c08e66a into main Jul 2, 2026
2 checks passed
@steipete
steipete deleted the fix/docs-release-current-state branch July 2, 2026 08:08
@steipete

steipete commented Jul 2, 2026

Copy link
Copy Markdown
Owner Author

Landed as c08e66ae0275935e82db7fb004c4e3d9a9cecfc9.

Proof for exact PR head 5f95a5e3c067642e8c28a2d4965bb9638ddb4807:

  • pnpm check
  • pnpm docs:build; generated install/spec/release pages contain the corrected Go minimum and automated tap flow
  • actionlint .github/workflows/*.yml
  • go mod verify
  • go mod tidy -diff
  • govulncheck ./...: no vulnerabilities found
  • autoreview: clean; no accepted/actionable findings
  • exact-head CI and GitGuardian: success — https://github.com/steipete/sag/actions/runs/28575147110
  • Public Model Identifier Gate: PASS; candidate diff and generated documentation introduced or changed no model identifiers

Live runtime proof is not applicable to this documentation/changelog-only change. The rendered documentation is the affected artifact and built successfully; no caveats.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5f95a5e3c0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/RELEASING.md
Comment on lines +18 to +20
- Verify the GitHub release:
- title is `sag <version>`
- body contains the complete changelog section plus links to the release commit, exact-head CI, live/behavior proof, and checksum manifest

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add a step to populate release notes

When cutting a new tag without pre-creating the GitHub release, this checklist now relies on the workflow-created release but never tells the maintainer how the required title/body get populated. I checked .github/workflows/release-binaries.yml and the upload step only passes tag_name and files to softprops/action-gh-release (no name, body, or generated-notes option), so the very next verification can fail unless someone knows to edit the release out-of-band. Please either add an explicit create/edit step here or wire the workflow to set the release metadata.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant