Skip to content

Repair the RubyGems release guide - #91

Merged
kvz merged 1 commit into
mainfrom
release-guide
Oct 18, 2026
Merged

kvz merged 1 commit into
mainfrom
release-guide

Conversation

@kvz

@kvz kvz commented Oct 18, 2026

Copy link
Copy Markdown
Member

Why: the documented release-notes command fails with a Ruby syntax error, and the guide leaves version selection, credentials, checks, and published-package verification unclear. These gaps surfaced while releasing 4.1.0 from #90.

Document the manual Docker publishing mechanism, clean main preparation, SemVer and Unreleased changelog handling, signed release commits, and explicit Docker/parity/e2e/lint/CI checks. Replace the broken notes command with guarded extraction and --notes-file. Add a scratch installation from rubygems.org and an offline Instructions smoke check. Keep publishing credentials outside the test .env.

Validation:

  • Published 4.1.0 with the existing helper. Docker: 140 tests / 378 assertions, no failures or skips, including parity and live upload; Standard Ruby passed. Release CI passed all five Ruby jobs and e2e.
  • RubyGems listing/API confirmed 4.1.0. Installed the published gem in scratch and checked binary multipart uploads: with typed fields under Docker --network none.
  • Reproduced the original notes SyntaxError. The replacement extracts exactly the four release bullets, cleans its temporary file, and stops on missing or empty entries; GitHub CLI was stubbed for failure checks.
  • Reproduced a leftover local gem shadowing the published version; --remote fetched the published gem from the same directory. Listing and installation explicitly select rubygems.org.
  • Release shell examples parse; git diff --check passes. Four council rounds completed, with rounds 3 and 4 both reporting “No issues found.”

🤖 Claimed by kvz on framework1/ruby-sdk since 2026-10-18 · resume: codex resume 01a14f97-caa3-7c90-ba9a-7917406341be

@kvz kvz self-assigned this Oct 18, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.89%. Comparing base (a7dfab8) to head (f17ecf5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #91   +/-   ##
=======================================
  Coverage   98.89%   98.89%           
=======================================
  Files           9        9           
  Lines         363      363           
  Branches       46       46           
=======================================
  Hits          359      359           
  Misses          1        1           
  Partials        3        3           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kvz
kvz merged commit 966c15a into main Oct 18, 2026
6 checks passed
@kvz
kvz deleted the release-guide branch October 18, 2026 15:42
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.

2 participants