Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: explain local service version parity#45782

Open
aqilaziz wants to merge 1 commit into
supabase:masterfrom
aqilaziz:docs-service-version-parity
Open

docs: explain local service version parity#45782
aqilaziz wants to merge 1 commit into
supabase:masterfrom
aqilaziz:docs-service-version-parity

Conversation

@aqilaziz
Copy link
Copy Markdown

@aqilaziz aqilaziz commented May 11, 2026 •
edited
Loading

I have read CONTRIBUTING.md

Yes.

What kind of change does this PR introduce?

Documentation update.

Current behavior

The local Supabase CLI getting-started guide does not clearly explain how local service versions are chosen, how linked project versions are cached, or how developers should align local stack versions with a remote project.

Fixes supabase/cli#4739.

New behavior

Adds a Service versions section that explains CLI defaults, linked project versions, pinned local stack versions, Postgres major version config, supabase status, supabase stack update, and one-off --service-version overrides.

Additional context

Verification:

  • git diff --check

@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

5 Skipped Deployments
Project Deployment Actions Updated (UTC)
design-system Skipped Skipped May 11, 2026 8:04am
studio-self-hosted Skipped Skipped May 11, 2026 8:04am
studio-staging Skipped Skipped May 11, 2026 8:04am
ui-library Skipped Skipped May 11, 2026 8:04am
zone-www-dot-com Skipped Skipped May 11, 2026 8:04am

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 11, 2026

Thanks for contributing to Supabase! ❤️ Our team will review your PR.

A few tips for a smoother review process:

  • If you have a local version of the repo, run pnpm run format to make sure formatting checks pass.
  • Once we've reviewed your PR, please don't trivially merge master (don't click Update branch if there are no merge conflicts to be fixed). This invalidates any pre-merge checks we've run.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

@aqilaziz is attempting to deploy a commit to the Supabase Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 11, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

This PR adds a new "Service versions" section to the CLI getting-started guide, explaining how Supabase CLI manages local service versions, how to link and update pinned versions, and how to align Postgres major versions or override versions for individual runs.

Changes

Service Versions Documentation

Layer / File(s) Summary
Service Versions Guide Section
apps/docs/content/guides/local-development/cli/getting-started.mdx		 New documentation section explains default service versions, how remote versions are cached when linked to a project, commands to update pinned versions (supabase link, supabase status, supabase stack update), local Postgres major version alignment via supabase/config.toml, and one-off version overrides using --service-version flag.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📚 A rabbit hops through docs so fine,
Service versions now align!
No more mysteries, no more fright—
Each local stack shines crystal bright! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation about local service version parity.
Linked Issues check ✅ Passed The PR successfully addresses all requirements from issue #4739: explains default image versions, documents how to pin versions via config.toml, covers supabase link and stack update commands, and provides service version override guidance.
Out of Scope Changes check ✅ Passed All changes are directly related to the linked issue #4739. The PR adds only documentation about service versions to the CLI getting-started guide with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description is well-structured and comprehensive, covering all required template sections with clear explanations of the changes.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

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.

@aqilaziz
Copy link
Copy Markdown
Author

aqilaziz commented May 11, 2026

Updated the PR description to follow the repository template sections noted by CodeRabbit.

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

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation / Project Config - Service Version Parity Transparency

1 participant

@aqilaziz