docs: add v7 migration guide (v6 → v7) - #1396
Open
tusharpandey13 wants to merge 8 commits into
Open
Conversation
Add v7_MIGRATION_GUIDE.md covering the 6.x to 7.x upgrade: Authentication API removed from the main entrypoint, the removed-exports table, and the Management-side breaking changes (mTLS explicit fetch, mTLS/client-assertion mutual exclusion, bare-hostname domain validation, ManagementError on token acquisition failures, uuid dependency removed). Delegates the auth-layer rewrite detail to AUTH_MIGRATION_GUIDE.md rather than duplicating it, and links the legacy entrypoint as a stopgap. Link the new guide from the README documentation list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
tusharpandey13
force-pushed
the
docs/v7-migration-guide
branch
from
August 27, 2026 12:18
6a628b2 to
dd07f02
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1396 +/- ##
=======================================
Coverage 89.83% 89.83%
=======================================
Files 446 446
Lines 21371 21371
Branches 9999 9999
=======================================
Hits 19198 19198
Misses 2173 2173
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
Author
|
The "Removed exports" table covers the auth-layer removals but is missing three low-level HTTP wrapper types that PR #1397 also removes from the public entrypoint:
Suggest adding these rows so the guide is a complete upgrade checklist. Context: they are deleted in #1397 ( |
- Add an agent-skill callout pointing to the auth0 migrate-node-auth0 skill. - Point the authentication-migration section at the guide's P0 OIDC start and its migration/ directory. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The auth migration guide moved from AUTH_MIGRATION_GUIDE.md into the scoped auth-migration/ directory (root file is now a stub). Update the references to the directory and its index.md landing page. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Drop internal implementation notes from the AI-agent skill callout - Remove all em dashes - Replace the orphaned P0 section reference with a named link Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
3 tasks
Short README section points to the v7 Migration Guide for method mapping, error-handling changes, and mTLS notes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The README v6-to-v7 section ships in the auth-separation code PR, which is the canonical owner. Keeping a competing section here caused an add/add conflict at the same anchor. The v7 guide stays linked from the Documentation list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…PR merge conflict Matches the Documentation-list block in the auth-migration PR so the two PRs make an identical insertion and merge cleanly in either order. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
v7_MIGRATION_GUIDE.md, the release-level upgrade guide for6.x→7.x, following the conventions of the existing v5/v6 guides. Kept separate from the Authentication API deep-dive guide (#1395), which it references rather than duplicates.v7 makes
node-auth0a Management-API-only SDK. This guide is the umbrella that covers the full breaking surface of that release:AUTH_MIGRATION_GUIDE.mdfor the method-by-method rewrite.AuthenticationClient,UserInfoClient,AuthApiError,AuthenticationClientOptions,IDTokenValidateOptions,IdTokenValidatorError,TokenSet,SUBJECT_TOKEN_TYPES,UserInfoResponse,UserInfoError, each mapped to its v7 replacement.fetch; mTLS + client-assertion mutually exclusive; bare-hostnamedomainvalidation; token-acquisition failures throwManagementError;uuiddependency removed.Also links the new guide from the README documentation list.
Why a separate guide (not a rename of AUTH_MIGRATION_GUIDE)
AUTH_MIGRATION_GUIDE.md(#1395) is a topic guide for the auth-layer rewrite and explicitly scopes out the Management API. v7 is a superset: it also covers the Management-side breaks and the export-surface removals, matching how the v6 guide is the release umbrella. Renaming the auth guide would silently drop two-thirds of the v7 breaking surface.Related PRs
🤖 Generated with Claude Code