Skip to content

docs: describe the PR and tag release flow - #88

Merged
cardmagic merged 1 commit into
mainfrom
polecat/rust/sr-ama+mv1o1coo
Oct 10, 2026
Merged

cardmagic merged 1 commit into
mainfrom
polecat/rust/sr-ama+mv1o1coo

Conversation

@cardmagic

@cardmagic cardmagic commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

Why

The "Release Workflow" section of AGENTS.md told the maintainer to commit and push main, and then to push a tag. No release does that. Each release since August went through a pull request. An agent that obeyed the old text would push a release commit directly to main.

What changed

Only AGENTS.md changed. The "Release Workflow" section now gives the real steps in order:

  1. A chore: prepare version X.Y.Z commit in a pull request updates lib/solid_objects/version.rb, the CHANGELOG.md section for the version, and Gemfile.lock.
  2. The maintainer reads docs/virtual-actors.md and docs/agents.md against the release. The old section had this step, and it stays.
  3. bundle exec rake runs before the push.
  4. The pull request needs a Greptile 5/5 summary on its head commit, green CI, and the approval of the maintainer. It merges with a merge commit.
  5. The tag goes on the merge commit on main. The example command uses the placeholder vX.Y.Z and not a real version number.
  6. After the gem is on RubyGems, the workspace solid-objects-tag-to-prod skill updates and deploys solidobjects.dev. The check:release sentence and the Context7 sentence from the old section stay.

The section also states the version rule before 1.0: a feature or a behavior change gets a minor version, and a fix gets a patch version.

Effects

  • API, correctness, security, migration, compatibility: none. This is maintainer documentation.
  • No version change and no CHANGELOG.md entry. This is maintainer documentation only.
  • No docs/roadmap.md edit. The change edits prose only.

Tests

This change has no production code, so it has no new test and no quoted failing test output. No test reads AGENTS.md.

Validation

Command: bundle exec rake on commit ee0f9aa, rebased on origin/main (8c9f0f9).

  • Run 1: FAILED in the test task. 921 runs, 3507 assertions, 1 failures, 1 errors, 28 skips.
    • EffectRecoveryTest#test_a_running_effect_keeps_its_process_heartbeat_fresh: Expected: "processing" Actual: "completed".
    • VerticalSliceTest#test_sync_returns_a_durable_result_without_another_worker: SolidObjects::SyncTimeout: actor invocation timed out after 2 seconds.
    • The machine had a load average of 62 on 10 cores during this run.
  • The two test files alone, three runs: each run gave 27 runs, 97 assertions, 0 failures, 0 errors, 8 skips.
  • Run 2: PASSED, exit status 0. 921 runs, 3514 assertions, 0 failures, 0 errors, 28 skips. RuboCop: 304 files inspected, no offenses detected. Steep: No type error detected. Brakeman: Security Warnings: 0.

The two failures in run 1 are not related to this change. A follow-up task records them. The cause is not proven. The hypothesis is that each test depends on a short wall-clock threshold.

The 28 skips occur in each run on SQLite. I did not examine them, because this change does not touch an adapter.

The Release Workflow section told the maintainer to commit and push
main. No release does that. Each release since August went through a
pull request, and the tag went on the merge commit.

The section now gives the real steps in order: the prepare commit in a
pull request, the documentation check, the local gate, the merge
conditions, the tag on the merge commit, and the site deploy. It also
states the version rule that applies before 1.0. The example tag
command uses a placeholder and not a real version number.
@context7

context7 Bot commented Oct 10, 2026

Copy link
Copy Markdown

Docs7 for cardmagic/solid-objects-ruby

Result Status Action
Deployment ➖ Not used —
Content review ✅ Passed. No problems found. View findings

Commit ee0f9aa

@greptile-apps

greptile-apps Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low impact] This documentation-only change appears safe to merge.

Summary

AGENTS.md now describes releasing through a pull request instead of pushing a release commit directly to main.

  • Releases go through a pull request before maintainers tag and publish them.

Reviews (1) · Last reviewed commit: "docs: describe PR and tag release flow (..." · Reviewed by Greptile

@cardmagic
cardmagic merged commit 8c6f32c into main Oct 10, 2026
64 of 65 checks passed
@cardmagic
cardmagic deleted the polecat/rust/sr-ama+mv1o1coo branch October 10, 2026 02:09
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