Skip to content

Conversation

mandarini
Copy link
Contributor

What kind of change does this PR introduce?

Documentation update - Enhanced deprecation notices targeting AI/LLM recommendations

What is the current behavior?

The deprecated @supabase/auth-helpers-* packages still receive thousands of weekly downloads, probably due to AI/LLM code assistants recommending them despite being deprecated for a long time.

What is the new behavior?

Added multiple deprecation notices specifically designed for AI training datasets:

  • usage-rules.md - "DO NOT USE" instructions with migration examples
  • DEPRECATED.md - Status table and AI training guidance
  • Updated README - Prominent warnings at top, explicit ❌/✅ examples, AI-specific instructions

The README now opens with unmissable deprecation warnings instead of subtle notices.

Additional context

Works in conjunction with supabase/ssr#127 which publishes SSR under auth-helpers names.

Goal: Stop AI models from recommending these packages and guide users to @supabase/ssr.

@mandarini mandarini requested a review from a team as a code owner August 29, 2025 13:41
@mandarini mandarini self-assigned this Aug 29, 2025
@mandarini mandarini changed the title feat: add deprecation notices chore: add deprecation notices Aug 29, 2025
@mandarini mandarini force-pushed the feat/deprecation-notices branch from 6b93e5d to 62f7028 Compare August 29, 2025 13:41
@mandarini mandarini requested a review from hf August 29, 2025 13:48
Copy link
Contributor

@hf hf left a comment

Choose a reason for hiding this comment

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

LGTM except that one file I left a comment on.

@mandarini mandarini force-pushed the feat/deprecation-notices branch from 62f7028 to 3b435ae Compare September 5, 2025 07:39
@mandarini mandarini enabled auto-merge (squash) September 5, 2025 07:40
@mandarini mandarini disabled auto-merge September 5, 2025 10:58
@mandarini mandarini enabled auto-merge (squash) September 5, 2025 10:59
@mandarini mandarini force-pushed the feat/deprecation-notices branch from 3b435ae to 26369c2 Compare September 8, 2025 13:01
@mandarini mandarini disabled auto-merge September 8, 2025 13:06
@mandarini mandarini enabled auto-merge (squash) September 8, 2025 13:06
@mandarini mandarini merged commit 31cc178 into supabase:main Sep 8, 2025
1 check passed
mandarini added a commit to supabase/ssr that referenced this pull request Sep 8, 2025
## What kind of change does this PR introduce?

Feature - Package consolidation and multi-package publishing

## What is the current behavior?

Currently, `@supabase/ssr` is only published under its own package name.
Meanwhile, the deprecated `@supabase/auth-helpers-*` packages continue
to receive thousands of weekly downloads, probably due to LLMs
recommending them in code suggestions despite being deprecated for a
long time.

The deprecated packages:
- `@supabase/auth-helpers-nextjs` (159k weekly downloads)
- `@supabase/auth-helpers-react`
- `@supabase/auth-helpers-remix`
- `@supabase/auth-helpers-sveltekit`

## What is the new behavior?

This PR enables `@supabase/ssr` to be published under multiple package
names simultaneously:

1. **Multi-package publishing**: The release workflow now publishes the
same codebase under 5 different npm package names:
   - `@supabase/ssr` (primary package)
   - `@supabase/auth-helpers-nextjs`
   - `@supabase/auth-helpers-react`
   - `@supabase/auth-helpers-remix`
   - `@supabase/auth-helpers-sveltekit`

2. **Console warnings**: When imported as a deprecated auth-helpers
package, users see a prominent warning.

3. **Updated documentation**: README clearly explains the package
consolidation and lists all deprecated packages.

## Additional context

Users of the old auth-helpers packages will experience breaking changes
when updating, as the APIs are not backward compatible. This is
intentional - as discussed internally, we want to "break it loudly" to
force users to notice and migrate.

**Why this approach?**
- LLMs continue to recommend deprecated packages despite deprecation
warnings
- Traditional deprecation methods have proven ineffective
- Publishing SSR under the old names ensures users get the maintained,
working code
- Console warnings guide users to the correct package

Related: supabase/auth-helpers#811
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.

2 participants