Skip to content

Clarify release workflow messaging and tooling - #32

Merged
blackopsrepl merged 1 commit into
mainfrom
issue-13-release-messaging
Mar 21, 2026
Merged

blackopsrepl merged 1 commit into
mainfrom
issue-13-release-messaging

Conversation

@blackopsrepl

Copy link
Copy Markdown
Contributor

Closes #13.

Summary

  • narrow the README claim so the npm-free story applies to consumer integration, not maintainer release tooling
  • document that version bump targets require Node.js and npx commit-and-tag-version
  • make the changelog framing human-readable instead of treating the release helper as the primary public contract

@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: 0b5d375854

ℹ️ 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 README.md
Comment on lines +445 to +449
- Runtime and application integration use only the bundled static assets and the Rust crate.
- Version bump targets in `Makefile` currently use `npx commit-and-tag-version`.
- Release and publish validation otherwise run through Cargo and GitHub Actions.

If you are cutting a release locally, make sure Node.js with `npx` is available before using the `bump-*` targets.

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 Document the required tag push after bump-*

For maintainers cutting a release locally, this section still omits the step that actually starts the automation: pushing the generated v* tag. I checked .forgejo/workflows/release.yml:4-6, .github/workflows/release.yml:4-7, and .github/workflows/publish-crates.yml:4-6; all of them trigger on tag pushes, while make bump-* only creates the commit/tag locally. Following the README as written can therefore leave release creation and crates.io publishing idle until someone separately does git push --follow-tags (or equivalent).

Useful? React with 👍 / 👎.

@blackopsrepl
blackopsrepl force-pushed the issue-13-release-messaging branch from 0b5d375 to 405112f Compare March 21, 2026 13:07
@blackopsrepl
blackopsrepl merged commit f99320b into main Mar 21, 2026
1 check passed
@blackopsrepl
blackopsrepl deleted the issue-13-release-messaging branch May 15, 2026 18:27
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.

Clarify or simplify the release workflow so product messaging matches reality

1 participant