Skip to content

Added a dependency catalog section to AGENTS.md#28032

Merged
9larsons merged 1 commit into
mainfrom
docs/pnpm-catalog-contributor-guide
May 21, 2026
Merged

Added a dependency catalog section to AGENTS.md#28032
9larsons merged 1 commit into
mainfrom
docs/pnpm-catalog-contributor-guide

Conversation

@9larsons
Copy link
Copy Markdown
Contributor

@9larsons 9larsons commented May 21, 2026

The pnpm catalog now pins ~60 shared dependencies, and catalogMode is strict — so a contributor running pnpm add will see the dependency routed into pnpm-workspace.yaml automatically, with nothing in the repo explaining why.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Review Change Stack

Walkthrough

This PR adds a "Dependency Catalog" section to AGENTS.md that documents centralizing shared dependency versions in pnpm-workspace.yaml via catalog: (including named catalog:<name>), explains catalogMode: strict routing of pnpm add into the catalog, and notes that pnpm publish rewrites catalog: references for @tryghost/* packages while advising against npm publish.

Possibly related PRs

  • TryGhost/Ghost#27902: Introduces catalogMode: strict behavior referenced by the new documentation.
  • TryGhost/Ghost#27946: Updates workspace/package files to use catalog: references for shared devDependencies, matching the documentation’s usage examples.
  • TryGhost/Ghost#27958: Moves bson-objectid to a pnpm catalog-managed version, an example of the catalog workflow described in the docs.

Suggested reviewers

  • EvanHahn
  • troyciesco
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly reflects the main change: adding documentation about the pnpm dependency catalog to AGENTS.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description accurately explains the problem being addressed: the pnpm catalog with strict mode causing automatic dependency routing, and the lack of documentation about this behavior.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/pnpm-catalog-contributor-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@9larsons 9larsons force-pushed the docs/pnpm-catalog-contributor-guide branch 2 times, most recently from 79886bd to cc00bc5 Compare May 21, 2026 13:41
- the pnpm catalog now pins ~60 shared dependencies, and catalogMode is
  strict, so contributors running `pnpm add` will see deps routed into
  the catalog automatically with no explanation of why
- folded a one-line note into the Package Manager section covering how
  catalog refs work and why strict mode routes `pnpm add` that way
@9larsons 9larsons force-pushed the docs/pnpm-catalog-contributor-guide branch from cc00bc5 to 5c4d143 Compare May 21, 2026 13:47
@9larsons 9larsons merged commit 8c84fda into main May 21, 2026
26 checks passed
@9larsons 9larsons deleted the docs/pnpm-catalog-contributor-guide branch May 21, 2026 14:06
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