Skip to content

fix(docs): make packaged migration links portable - #2735

Open
Huzaifa-Asif wants to merge 1 commit into
supabase:masterfrom
Huzaifa-Asif:fix/portable-migration-links
Open

Huzaifa-Asif wants to merge 1 commit into
supabase:masterfrom
Huzaifa-Asif:fix/portable-migration-links

Conversation

@Huzaifa-Asif

@Huzaifa-Asif Huzaifa-Asif commented Oct 3, 2026 •

Copy link
Copy Markdown

🔍 Description

What changed?

Replace the repository-relative cross-cutting migration link in each core package's shipped migrations/README.md with the canonical Supabase JS migration guide URL.

Why was this change needed?

The relative link works in the source monorepo but resolves to the consuming application's nonexistent docs/MIGRATION.md after the package is installed. An absolute canonical URL remains usable from the published package layout.

Closes #2734

📸 Screenshots/Examples

Not applicable; this fixes links in packaged Markdown files.

🔄 Breaking changes

  • This PR contains no breaking changes

📋 Checklist

  • I have read the Contributing Guidelines
  • My PR title follows the conventional commit format
  • npx --no-install nx format:check passed on all six changed files
  • Tests for new functionality are not applicable to this documentation-only change
  • I have updated documentation

📝 Additional notes

Verification packed all six core packages and inspected each tarball to confirm its shipped migration README contains the canonical URL. git diff --check also passes.

AI assistance disclosure: OpenAI Codex assisted with issue research, the documentation edits, package-output verification, and drafting this description. The contributor reviewed the submitted change on 2026-10-04, after the draft PR had been opened.

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (3)
packages/core/realtime-js/AGENTS.md — auto-discovered
packages/core/functions-js/AGENTS.md — auto-discovered
packages/core/auth-js/AGENTS.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7ee4cecc-26c3-406f-9380-aeafeeea9431
📥 Commits

Reviewing files that changed from the base of the PR and between cb76828 and 6cdbd90.

📒 Files selected for processing (6)
  • packages/core/auth-js/migrations/README.md
  • packages/core/functions-js/migrations/README.md
  • packages/core/postgrest-js/migrations/README.md
  • packages/core/realtime-js/migrations/README.md
  • packages/core/storage-js/migrations/README.md
  • packages/core/supabase-js/migrations/README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated migration guide links across the JavaScript package documentation to point to the repository’s GitHub-hosted migration notes.
    • Updated the storage package’s repository link to point to the GitHub repository. These links now work consistently when viewing the guides outside a local checkout, such as on GitHub.

Walkthrough

The migration READMEs for all six core packages now link to the repository migration guide using GitHub URLs instead of relative paths. The change affects documentation links only.

Assessment against linked issues

Objective Addressed Explanation
Make the cross-cutting migration guide reachable from each published package README outside a source checkout [#2734] ✅

Priority: ⚪ Not assessed

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 6cdbd

The packaged migration documentation now directs consumers to the shared guide.

Architecture Summary

Architecture risk: 🔵 Low · up to 6cdbd

The change affects 1 system.

Changed systems: packages/core

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — packages/core (library) was modified; 6 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in packages/core/auth-js/migrations/README.md: The link to the repository-level migration guide changes from a relative path to its GitHub URL; the surrounding scope description is unchanged.
  • observed — Modified behavior in packages/core/functions-js/migrations/README.md: The repository-wide migration documentation link changes from a relative path to the GitHub master URL; the note’s scope remains @supabase/functions-js only.
  • observed — Modified behavior in packages/core/postgrest-js/migrations/README.md: The repository-level migration guide link changed from a relative path to the GitHub URL; the surrounding scope description is unchanged.
  • observed — Modified behavior in packages/core/realtime-js/migrations/README.md: The link to the repository-level migration guide now uses its GitHub URL instead of a relative repository path.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@Huzaifa-Asif
Huzaifa-Asif marked this pull request as ready for review October 4, 2026 06:34
@Huzaifa-Asif
Huzaifa-Asif requested review from a team as code owners October 4, 2026 06:34

This branch has not been deployed

No deployments
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.

fix(docs): packaged migration README links resolve outside the installed packages

1 participant