docs: refresh deployment section for unified workflow + bump Next.js to 16#51
Conversation
…to 16
Two issues the README didn't reflect:
1. Tech-stack header said "Next.js 15"; package.json has been on
^16.2.4 for a while.
2. Deployment section described an outdated single-trigger workflow
that only deployed to production on `release: published`, and
listed a stale, partially-incorrect mix of secrets and variables.
Updates:
- Production / Staging Architecture section now lists all three
subdomains (catholicdigitalcommons.org,
staging.catholicdigitalcommons.org, cms.catholicdigitalcommons.org)
and explains that staging shares the production WordPress backend.
- Notes the proxy.ts noindex behavior so anyone reading the README
understands why staging never appears in search results.
- Documents that runtime env (WP_GRAPHQL_URL, WP_PREVIEW_SECRET) is
configured in the Plesk panel, not in .env files on disk.
Distinguishes that from NEXT_PUBLIC_SITE_URL which is baked into
the client bundle at build time.
GitHub Actions section rewritten for the unified deploy.yml:
- Documents both triggers (release and workflow_dispatch with
environment input)
- Adds gh CLI examples for non-interactive deploys
- Mentions the pr-build.yml required check
- Reorganizes the required-config table into separate Secrets
(credentials) and Variables (plain config) sections, listing all
the entries the unified workflow actually reads:
- secrets: VPS_HOST, VPS_USERNAME, VPS_SSH_KEY, WP_APP_USERNAME,
WP_APP_PASSWORD
- vars: WP_GRAPHQL_URL, WP_REST_URL, NEXT_PUBLIC_SITE_URL_PROD,
NEXT_PUBLIC_SITE_URL_STAGING, VPS_APP_DIR, VPS_STAGING_APP_DIR,
WP_THEME_DIR, WP_PLUGINS_DIR
Note: assumes PR #50 (workflow unification) lands first. If the
sequencing flips, the gh CLI command syntax in this README will be
wrong until #50 merges.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME.md is updated to document Next.js version 16 migration and a revised deployment architecture supporting both production and staging environments on a single Plesk host, including updated CI/CD workflows and configuration requirements. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 56 minutes and 11 seconds.Comment |
Up to standards ✅🟢 Issues
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 310-327: The README's deploy command examples and description are
inconsistent with the current workflows: the repo still uses separate
deploy-staging.yml and deploy.yml and deploy.yml's workflow_dispatch has no
environment input. Fix by either (A) updating README examples and text to show
the real commands (use gh workflow run deploy-staging.yml --ref main for staging
and gh workflow run deploy.yml --ref main for production, and remove references
to an environment input), or (B) change the workflows to match the doc by adding
an environment input to deploy.yml's workflow_dispatch and consolidating staging
logic into deploy.yml (and remove or deprecate deploy-staging.yml); reference
deploy.yml, deploy-staging.yml, and the workflow_dispatch input to locate and
update the relevant files.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Five badges in a row under the title: - Next.js, React, TypeScript, Tailwind CSS — all read from package.json on main via shields.io's /github/package-json/dependency-version endpoint, so they update automatically whenever dependencies bump (no more drift like the "Next.js 15" header that was wrong for months) - PR Build — the new pr-build.yml workflow status on main, so anyone glancing at the README sees green/red at a glance Each links to the project's homepage. No license badge: package.json has no license field and there's no LICENSE file in the repo. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 participant
Summary
Two issues the README didn't reflect:
package.jsonhas beenon
^16.2.4for a while.workflow that only deployed to production on
release: published, and listed a stale, partially-incorrect mix ofsecrets and variables.
Changes
subdomains and explains that staging shares the production
WordPress backend
proxy.tsnoindex behavior so future readers understandwhy staging never appears in search results
.envfiles on disk), distinguishing it from the build-timeNEXT_PUBLIC_SITE_URLbaked into the client bundledeploy.yml:release,workflow_dispatchwith environmentinput)
gh CLIexamples for non-interactive deployspr-build.ymlrequired checkVariables (plain config), listing exactly what the unified
workflow reads
Sequencing note
This PR assumes #50 (workflow unification) lands first. If
sequencing flips, the
ghCLI command syntax in this README iswrong until #50 merges.
🤖 Generated with Claude Code
Summary by CodeRabbit