Publishing a new version of MDN mdn-data

May 17, 2023 · View on GitHub

Releases are published on GitHub and to the npm registry as the mdn-data package. This is then used by MDN to generate sidebars as well as other features such as info boxes on pages.

In order to publish a release:

  1. Commits need to adhere to conventional commits and only fix: and feat: commits are considered.
  2. The publish-release.yml workflow reuses the mdn/workflows workflow by the same name.
  3. The workflow uses release-please, which opens a release pull request if there are relevant commits (following the conventions described in step 1) on the main branch since the last-published version.
  4. When the pull request from step 3 is merged, release-please creates a GitHub release and a package is published to npm via the publish-release.yml workflow.

After these steps have completed, you may check mdn-data on npm to see if the release shows up correctly. 🎉