Skip to content

Updated docs for public adapter base packages - #29556

Merged
acburdine merged 1 commit into
mainfrom
feat/adapter-docs
Jul 23, 2026
Merged

Updated docs for public adapter base packages#29556
acburdine merged 1 commit into
mainfrom
feat/adapter-docs

Conversation

@acburdine

Copy link
Copy Markdown
Member

no ref

  • update README documentation for published packages with usage + other info
  • remove duplicate LICENSE files from packages (pnpm publish ships the root one automatically)

no ref
- update README documentation for published packages with usage + other info
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Expanded the cache, scheduling, SSO, and storage adapter READMEs with implementation examples, required methods, installation steps, and Ghost activation configuration. Revised ESM and TypeScript build guidance by removing prior module-resolution and CommonJS compatibility details. Added Changesets metadata for patch updates to four adapter-related packages and recorded the documentation changes.

Possibly related PRs

  • TryGhost/Ghost#29514: Covers the related ghost-storage-base move and updated StorageBase export/import guidance.
  • TryGhost/Ghost#29554: Uses Changesets entries for overlapping scheduling and SSO adapter package releases.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: documentation updates for public adapter base packages.
Description check ✅ Passed The description matches the changeset, covering README updates and removal of duplicate LICENSE files.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/adapter-docs

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.

@nx-cloud

nx-cloud Bot commented Jul 23, 2026

Copy link
Copy Markdown

🤖 Nx Cloud AI Fix

Ensure the fix-ci command is configured to always run in your CI pipeline to get automatic fixes in future runs. For more information, please see https://nx.dev/ci/features/self-healing-ci


View your CI Pipeline Execution ↗ for commit 45dfa94

Command Status Duration Result
nx run-many -t test:unit -p @tryghost/adapter-b... ✅ Succeeded 33s View ↗
nx run ghost-monorepo:lint:boundaries ✅ Succeeded <1s View ↗
nx run-many -t lint -p ghost-monorepo,@tryghost... ✅ Succeeded 26s View ↗
nx run @tryghost/admin:build ✅ Succeeded 9s View ↗
nx run-many --target=build --projects=tag:publi... ✅ Succeeded <1s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-07-23 10:45:42 UTC

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/adapters/cache-base/README.md`:
- Around line 12-16: Replace the npm installation command with pnpm add in
packages/adapters/cache-base/README.md lines 12-16,
packages/adapters/scheduling-base/README.md lines 13-17,
packages/adapters/sso-base/README.md lines 12-16, and
packages/adapters/storage-base/README.md lines 12-16, preserving each package
name.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b431be32-ea28-4866-9733-936a70dda31c

📥 Commits

Reviewing files that changed from the base of the PR and between 767ef52 and 45dfa94.

📒 Files selected for processing (7)
  • .changeset/major-areas-fail.md
  • packages/adapters/cache-base/LICENSE
  • packages/adapters/cache-base/README.md
  • packages/adapters/scheduling-base/README.md
  • packages/adapters/sso-base/README.md
  • packages/adapters/storage-base/LICENSE
  • packages/adapters/storage-base/README.md
💤 Files with no reviewable changes (2)
  • packages/adapters/storage-base/LICENSE
  • packages/adapters/cache-base/LICENSE

Comment thread packages/adapters/cache-base/README.md
@acburdine
acburdine merged commit 4d1641a into main Jul 23, 2026
45 checks passed
@acburdine
acburdine deleted the feat/adapter-docs branch July 23, 2026 10:58
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