Skip to content

docs: add new-package checklist to CLAUDE.md - #345

Merged
matthv merged 3 commits into
mainfrom
docs/new-package-checklist
Aug 6, 2026
Merged

docs: add new-package checklist to CLAUDE.md#345
matthv merged 3 commits into
mainfrom
docs/new-package-checklist

Conversation

@matthv

@matthv matthv commented Aug 6, 2026

Copy link
Copy Markdown
Member

What

Adds a root CLAUDE.md with a checklist for scaffolding a new packages/* gem.

Why

PR #343 (new forest_admin_datasource_graphql_hasura package) missed the .rubocop.yml exclusions for its version.rb, and shipped that file with a format (VERSION = '1.0.0'.freeze) that silently breaks the .releaserc.js version-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.rb exact format (matches the release sed)
  • .rubocop.yml exclusions to add
  • .releaserc.js entries (3 spots)
  • .github/workflows/build.yml CI 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

  • Added checklist step requiring spec.metadata['rubygems_mfa_required'] set to 'false' in new .gemspec files with explanation that CI publishing is unattended [6ee9b00]
  • Updated RuboCop configuration requirements to exclude new version.rb from Style/MutableConstant and Style/StringLiterals cops and add new .gemspec to Gemspec/RequireMFA Exclude list [6ee9b00]
  • Renumbered subsequent checklist steps from step 3 to step 5, changing .releaserc.js to step 4 and .github/workflows/build.yml to step 5 [6ee9b00]
  • Corrected step reference in documentation note about sed command behavior [bf1bcfb]
📊 Macroscope summarized 6ee9b00. 1 file reviewed, 0 issues evaluated, 0 issues filtered, 0 comments posted

🗂️ Filtered Issues

No issues evaluated.

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>
Comment thread CLAUDE.md Outdated
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>
Comment thread CLAUDE.md Outdated
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>
@matthv
matthv merged commit 0384b08 into main Aug 6, 2026
48 checks passed
@matthv
matthv deleted the docs/new-package-checklist branch August 6, 2026 09:09
@forest-bot

Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.37.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants