Skip to content

CLAUDE.md

Latest commit

 

History

History
64 lines (52 loc) · 2.86 KB

CLAUDE.md

File metadata and controls

64 lines (52 loc) · 2.86 KB
Raw

CLAUDE.md

Adding a new package to the monorepo

When scaffolding a new packages/forest_admin_datasource_* (or any new) package, mirror an existing package's scaffold (Gemfile, Gemfile-test, Rakefile, .rspec, gemspec, LICENSE, spec/spec_helper.rb, .gitignore) and update every one of these in the same PR — missing one breaks CI or releases silently, not loudly:

  1. lib/<package>/version.rb — must be exactly:

    module <Module>
  VERSION = "0.1.0"
end

    Double quotes, no .freeze. The release sed in .releaserc.js only matches this exact format.

  2. New .gemspec — explicitly opt out of RubyGems MFA, matching every other package:

    spec.metadata['rubygems_mfa_required'] = 'false'

    Gem publishing runs unattended from CI (.releaserc.js), so it can't satisfy an MFA prompt.

  3. .rubocop.yml — add the new version.rb to:

    • Style/MutableConstant Exclude
    • Style/StringLiterals Exclude

    And the new .gemspec to Gemspec/RequireMFA Exclude — the cop flags the 'false' opt-out from step 2 as an offense, so it needs suppressing.

    (Other per-file excludes — Metrics/MethodLength, Metrics/BlockLength, Naming/PredicatePrefix — are added case-by-case only if the cop actually fires; don't copy them blindly.)

  4. .releaserc.js — add the package in all three spots:

    • prepareCmd: sed -i 's/VERSION = ".*"/VERSION = "${nextRelease.version}"/g' packages/<package>/lib/<package>/version.rb;
    • successCmd: ( cd packages/<package> && gem build && gem push <package>-*.gem );
    • @semantic-release/git assets: packages/<package>/lib/<package>/version.rb

  5. .github/workflows/build.yml — add the package name to:

    • the test job's packages matrix
    • the "Send coverage" step's files: list, as .../reports/<ruby-version>-<package>/coverage.json — the version prefix comes from the artifact name and is easy to drop, and a path that resolves to nothing is exactly the silent-zero case warned about there

    The lint job needs no entry: it runs one root bundle exec rubocop, and the root .rubocop.yml has no Include, so it already walks packages/**.

    A package with no spec suite (like forest_admin_test_toolkit) belongs in neither list: the Test step dies at BUNDLE_GEMFILE=Gemfile-test bundle install before rspec runs, and qlty's skip-errors default swallows a missing coverage.json instead of reddening the job. Such a package's own Gemfile is then resolved nowhere in CI — breakage surfaces only locally — though its gemspec still is, via the path: refs in five other packages' Gemfile-test.

After merging, verify the next release actually bumps the new version.rb — the sed in step 4 silently no-ops if the format from step 1 is off, with no CI failure to catch it.