docs: add v7 migration guide (v6 → v7) - #1396
Open
tusharpandey13 wants to merge 1 commit 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.73% 89.73%
========================================
Files 441 441
Lines 20799 20799
Branches 10146 9809 -337
========================================
Hits 18663 18663
Misses 2136 2136
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.Base branch
Targets
feat/auth-separation-v6(the v7[BREAKING]release branch, #1390) so the guide ships with the release it documents.Related PRs
🤖 Generated with Claude Code