Maintainer information#

Making a release#

For branch organization we use a variation of the GitHub Flow with the latest release branch named stable (due to ReadTheDocs constraints).

Making a major release#

  1. Make a new PR and for all occurrences of in ./docs/ replace dev with the release version vX.Y.Z (note the presence of the leading v). This also applies to docs/, but you should skip this file and docs/usage/

  2. Set the version in:

    • docs/project/ (the Zenodo citation),

    • docs/development/,

    • docs/usage/,

    • setup.cfg,

    • src/js/package.json,

    • src/py/pyodide/,

    • src/py/setup.cfg,

    • pyodide-build/setup.cfg,

    • … other places

    After this, try using ripgrep to make sure there are no extra old versions lying around e.g., rg -F "0.18", rg -F dev0, rg -F dev.0.

  3. Make sure the change log is up-to-date.

    • Indicate the release date in the change log.

    • Generate the list of contributors for the release at the end of the changelog entry with,

      git shortlog -s LAST_TAG.. | cut -f2- | sort --ignore-case | tr '\n' ';' | sed 's/;/, /g;s/, $//' | fold -s

      where LAST_TAG is the tag for the last release. Merge the PR.

  4. Assuming the upstream stable branch exists, rename it to a release branch for the previous major version. For instance if last release was, 0.20.0, the corresponding release branch would be 0.20.X,

    git fetch upstream
    git checkout stable
    git checkout -b 0.20.X
    git push upstream 0.20.X
    git branch -D stable    # delete locally
  5. Create a tag X.Y.Z (without leading v) and push it to upstream,

    git tag X.Y.Z
    git push upstream X.Y.Z

    Create a new stable branch from this tag,

    git checkout -b stable
    git push upstream stable --force

    Wait for the CI to pass and create the release on GitHub.

  6. Release the Pyodide JavaScript package:

    cd src/js
    npm publish # Note: use "--tag next" for prereleases
    npm dist-tag add pyodide@a.b.c next # Label this release as also the latest unstable release
  7. Revert Step 1. and increment the version in src/py/pyodide/ to the next version specified by Semantic Versioning.

  8. Update this file with any relevant changes.

Making a minor release#

For a minor release, commits need to be added to the stable branch, ideally via a PR. This can be done with either,

  • git cherry picking individual commits,

    git checkout stable
    git pull
    git checkout -b backport-branch
    git cherry-pick <commit-hash>
  • or with interactive rebase,

    git fetch upstream
    git checkout stable
    git pull
    git checkout -b backport-branch
    git rebase -i upstream/main

    and indicate which commits to take from main in the UI.

Then follow steps 2, 3, and 6 from Making a major release.

Making an alpha release#

Follow steps 2, 6, 7, and 9 from Making a major release. Name the first alpha release x.x.xa1 and in subsequent alphas increment the final number. For the npm package the alpha should have version in the format x.x.x-alpha.1. For the node package make sure to use npm publish --tag next to avoid setting the alpha version as the stable release.

If you accidentally publish the alpha release over the stable latest tag, you can fix it with: npm dist-tag add pyodide@a.b.c latest where a.b.c should be the latest stable version. Then use npm dist-tag add pyodide@a.b.c-alpha.d next to set the next tag to point to the just-published alpha release.

Fixing documentation for a released version#

Cherry pick the corresponding documentation commits to the stable branch. Use [skip ci] in the commit message.