Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
- Node.js 20 or higher
- yarn package manager
Install the project dependencies:
yarn installBuild the project:
yarn buildRun the test suite:
yarn testRun specific test types:
yarn test:unit- Run unit testsyarn test:wire- Run wire/integration tests
Check code style:
yarn run lint
yarn run format:checkFix code style issues:
yarn run lint:fix
yarn run format:fixOr use the combined check command:
yarn run check:fixImportant: Most files in this SDK are automatically generated by Fern from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
The following directories contain generated code:
src/api/- API client classes and typessrc/serialization/- Serialization/deserialization logic- Most TypeScript files in
src/
If you need to customize the SDK, you have two options:
For custom code that should persist across SDK regenerations:
- Create a
.fernignorefile in the project root - Add file patterns for files you want to preserve (similar to
.gitignoresyntax) - Add your custom code to those files
Files listed in .fernignore will not be overwritten when the SDK is regenerated.
For more information, see the Fern documentation on custom code.
If you want to change how code is generated for all users of this SDK:
- The TypeScript SDK generator lives in the Fern repository
- Generator code is located at
generators/typescript/sdk/ - Follow the Fern contributing guidelines
- Submit a pull request with your changes to the generator
This approach is best for:
- Bug fixes in generated code
- New features that would benefit all users
- Improvements to code generation patterns
- Create a new branch for your changes
- Make your modifications
- Run tests to ensure nothing breaks:
yarn test - Run linting and formatting:
yarn run check:fix - Build the project:
yarn build - Commit your changes with a clear commit message
- Push your branch and create a pull request
Write clear, descriptive commit messages that explain what changed and why.
This project uses automated code formatting and linting. Run yarn run check:fix before committing to ensure your code meets the project's style guidelines.
If you have questions or run into issues:
- Check the Auth0 documentation
- Search existing GitHub issues
- Open a new issue if your question hasn't been addressed
For questions about the Fern code generator itself, see the Fern documentation or Fern repository.
Applies only when working on the
betabranch.
This SDK ships two tracks from one npm package (auth0):
- Stable (
master): EA/GA endpoints only. Released by a maintainer via arelease/*branch. - Beta (
beta): a superset of stable plus beta-only endpoints. Released automatically when a PR is merged intobeta.
The beta branch is regenerated from the stable spec plus the beta-only spec files; it is never produced by merging master into beta. It receives one combined regeneration PR (stable + beta) as a single squash commit.
Beta uses the next stable minor + -beta.N, derived from git tags:
Latest stable: v6.3.0 → Next beta: v6.4.0-beta.0
Subsequent betas: v6.4.0-beta.1, v6.4.0-beta.2, ...
Once v6.4.0 ships: v6.5.0-beta.0
Because v6.4.0-beta.N sorts before v6.4.0 in semver, consumers running npm install auth0 will never receive a beta version unless they explicitly pin it:
# Stable (default)
npm install auth0
# Beta (explicit prerelease pin)
npm install auth0@beta
# or a specific version
npm install auth0@6.4.0-beta.0Squash and merge with a commit message that marks each group:
Regenerate SDK (stable + beta) (#<pr-number>)
<!-- BETA -->
- feat: add `Management.Sandbox` preview API (Beta)
<!-- /BETA -->
<!-- STABLE -->
- feat: add tenant security headers configuration
<!-- /STABLE -->
- Beta-only changes go inside the
BETAmarkers; stable-mirrored changes go inside theSTABLEmarkers. - The
<!-- ... -->markers are HTML comments and stay invisible in GitHub's rendered view. - Omitting a section renders a "No ... changes in this release." note; omitting both falls back to the raw commit subject. Always prefer the structured form.
- Everything reaches
betathrough a PR. Never push directly tobeta— a direct push will not trigger a release.
- The
npm-release-betaworkflow computes the nextvX.Y.0-beta.Nfrom git tags. - It aborts if that tag already exists (prevents overwriting a published release).
- It parses the
<!-- BETA -->/<!-- STABLE -->sections from the squash commit message. - It stamps
.version,package.json,src/management/version.ts, andCHANGELOG.mdon disk. - It builds the package and publishes to npm with
--tag beta --provenance. - It creates a signed release commit via the GitHub API (shows as Verified, no GPG key required).
- It tags the commit and publishes a GitHub prerelease.
The npm-release-beta workflow owns .version, package.json (version field), src/management/version.ts, and CHANGELOG.md on the beta branch. Never manually bump these files on beta.
Code outside of the Fern-generated directories is hand-written and is not regenerated on beta. A fix on master does not reach beta automatically, so hand-written changes must be PR'd to both master and beta.
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.