Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 2.73 KB

publishing.md

File metadata and controls

40 lines (22 loc) · 2.73 KB

Publishing a new version of MDN mdn-data

Repo admins publish new releases of mdn-data on npm. This is then used by MDN to generate various sidebars as well as other things.

Any admin can complete the following steps to publish a new version, but please coordinate releases with @ddbeck or @Rumyra.

The steps in this process assume:

Prepare for the release

Prepare for a release by creating a pull request to update metadata for the release. See #507 as an example.

  1. Start a new branch for the upcoming release. For example, run git switch -c release-YYYY-MM-DD, where YYYY-MM-DD is the target release date.

  2. Increment the package version with npm version --no-git-tag-version and commit the change.

    For example, to increment the version for a routine data update with no breaking changes or new features, run npm version --no-git-tag-version patch, then commit the changes to the package metadata files.

    If needed, you can repeat this step on the same branch, using a minor or major argument (instead of patch), to increment the version for newly-introduced features or breaking changes.

  3. Push the release branch to your remote, open a pull request, and then review/merge it.

Publish to npm

  1. Start a draft release on GitHub.

    • In the Tag version and Release title fields, enter vX.Y.Z where X.Y.Z is the version number you'd like to publish. Do not use an existing value, but instead select an increment from the previous release. For example, if the previous release was v2.0.20, use v2.0.21 for the Tag version and Release title fields.
    • You can leave the Describe this release field blank, or add notes as you wish.

    Note: If you're not ready to publish to npm, click Save draft in GitHub and resume this process later.

  2. Click Publish release to create the tag and trigger the workflow that publishes to npm. Wait for the npm publish GitHub Actions workflow to finish successfully.

  3. Check mdn-data on npm to see if the release shows up correctly.

The package is now published. 🎉