docs: add new-package checklist to CLAUDE.md - #345
Merged
Conversation
Codifies the checklist for scaffolding a new packages/* gem — version.rb format, .rubocop.yml exclusions, .releaserc.js entries, and build.yml CI matrix — after PR #343 missed the rubocop exclusion and shipped a version.rb format that silently breaks the release version-bump sed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
bexchauveto
reviewed
Aug 6, 2026
Per bexchauveto's review on #345: the .rubocop.yml Gemspec/RequireMFA exclusion only exists because the gemspec explicitly opts out of MFA (spec.metadata['rubygems_mfa_required'] = 'false') since gem publishing runs unattended from CI. Document that step, not just its rubocop suppression. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Macroscope flagged on PR #345 that the closing note pointed to step 3 (rubocop excludes) for the release sed, but the sed lives in step 4 (.releaserc.js). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
bexchauveto
approved these changes
Aug 6, 2026
Member
|
🎉 This PR is included in version 1.37.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
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.
What
Adds a root
CLAUDE.mdwith a checklist for scaffolding a newpackages/*gem.Why
PR #343 (new
forest_admin_datasource_graphql_hasurapackage) missed the.rubocop.ymlexclusions for itsversion.rb, and shipped that file with a format (VERSION = '1.0.0'.freeze) that silently breaks the.releaserc.jsversion-bump sed — no CI failure catches either issue. This isn't the first time these steps have been missed when a package is scaffolded; they're currently tribal knowledge copy-pasted from the last package rather than documented anywhere.What's covered
version.rbexact format (matches the release sed).rubocop.ymlexclusions to add.releaserc.jsentries (3 spots).github/workflows/build.ymlCI matrices + coverage list🤖 Generated with Claude Code
Note
Add new-package checklist to CLAUDE.md
Documents the required steps when adding a new package to the monorepo in CLAUDE.md. Covers version file format, RuboCop excludes, semantic-release config updates, and CI workflow matrix and coverage path entries.
Changes since #345 opened
spec.metadata['rubygems_mfa_required']set to'false'in new.gemspecfiles with explanation that CI publishing is unattended [6ee9b00]version.rbfromStyle/MutableConstantandStyle/StringLiteralscops and add new.gemspectoGemspec/RequireMFAExclude list [6ee9b00].releaserc.jsto step 4 and.github/workflows/build.ymlto step 5 [6ee9b00]sedcommand behavior [bf1bcfb]📊 Macroscope summarized 6ee9b00. 1 file reviewed, 0 issues evaluated, 0 issues filtered, 0 comments posted
🗂️ Filtered Issues
No issues evaluated.