Scripts

Release

A typical release goes like this:

Prerequisites

1. You must be a member of the @base-ui org in npm to publish the release.
2. Set up your npm authToken by logging into npm (npm login) . This will save a token to ~/.npmrc as a line that looks like this:

   //registry.npmjs.org/:_authToken=npm_000000000000000000000000000000000000
   

3. Generate a GitHub Token at https://github.com/settings/personal-access-tokens/new and add it to your shell rc script (either .bashrc or .zshrc) as GITHUB_TOKEN.
   • When creating the token, choose mui as the Resource owner.
   • Set expiration to 366 days or less.
   • Set Public Repositories (read-only) in Repository access.
   • Organization permissions are not required.

Prepare the release of the packages

1. Update the root /package.json's version.
2. Generate the changelog with pnpm release:changelog The output must be prepended to the top level CHANGELOG.md. Run pnpm release:changelog --help for more information. If your GitHub token is not in your env, pass it as --githubToken <my-token> to the above command.
3. Update the changelog as necessary. In particular, describe all the breaking changes.
4. Generate the changelog in a format suitable for the docs with pnpm release:changelog:docs.
5. Create a new release page at docs/src/app/(docs)/react/overview/releases/<version-slug>/page.mdx (where <version-slug> uses hyphens, for example, v1-1-0 for v1.1.0). Paste the generated changelog there, following the format of existing release pages (title, <Subtitle> with the date, <Meta> tag).
6. Copy the changes made in point 3 to the new release page.
7. Add a new entry to docs/src/data/releases.ts with the version, versionSlug, date, and highlights. Move the latest: true flag to the new release if appropriate.
8. Run pnpm release:version. Keep the package versions of stable public packages the same as the root package.json version.
9. Open a PR with changes and wait for review and green CI.
10. Merge the PR once the CI is green and it has been approved.

Release the packages

1. Run pnpm release:publish. You may be asked to authenticate with GitHub when running the command for the first time or after a very long time.

2. It'll automatically fetch the latest merged release PR and ask for confirmation before publishing.

3. If you already know the sha of the commit, you can pass it directly like pnpm release:publish --sha <your-sha>.

4. Other flags for the command:

   • --dry-run Used for debugging. Or directly run pnpm release:publish:dry-run.
   • --dist-tag Use to publish legacy or canary versions.

5. This command invokes the Publish GitHub action. It'll log the url which can be opened to see the latest workflow run.

6. The next screen shows "@username requested your review to deploy to npm-publish", click "Review deployments" and authorize your workflow run. Never approve workflow runs you didn't initiaite.

Publish the documentation

The documentation must be updated on the docs-vX branch (docs-v1 for v1.X releases, docs-v2 for v2.X releases, etc.)

Push the working branch to the documentation release branch to deploy the documentation with the latest changes:

pnpm docs:deploy

You can follow the deployment process on the Netlify Dashboard Once deployed, it will be accessible at https://base-ui.netlify.app/ for the docs-v1 deployment.

GitHub release

After the documentation deployment is done, review, and then publish the release that was created in draft mode during the release step GitHub releases page Make sure to check the Set as a pre-release checkbox if publishing an unstable version.