Make a release

The extension can be published to PyPI and npm using the Jupyter Releaser.

Automated releases with the Jupyter Releaser¶

Here is a summary of the steps to cut a new release:

• If a new mystmd has been released and you want to bump the version, follow the instructions below and merge into main before making the release. This is the most common reason to make a new release!

• In the Actions panel, go to the Step 1: Prep Release workflow.

  • Click Run Workflow -> Run Workflow with default values.

• Go to the Releases page

  • When Step 1 completes, you’ll see a new Draft release with the changelog.

  • If you don’t see it yet, refresh the page once the workflow from Step 1 completes.

  • If it looks good, proceed to the next step!

• Go to the Step 2: Publish Release workflow page

  • Click Run Workflow -> Run Workflow with default values.

  • This will publish the release.

Updating mystmd dependencies¶

Jupyter Book ships the MyST engine via the myst-cli Node dependency in package.json.

To pick up a new mystmd release, update the myst-cli version in package-lock.json:

$ npm update myst-cli

This will change several entries in the lockfile, because the myst-cli package has its own dependencies. This is to be expected! Then make a PR with this new version and merge it.

Note: Double check that any changes in the mystmd package don’t require a change here! (usually this is not the case)

Publishing to conda-forge¶

A bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.