Skip to content

Making a release

Mathieu Scheltienne edited this page Jan 16, 2024 · 5 revisions

This is a very rough draft of how to make a release. Most likely generalization to any repo that follows the mne-icalabel structure with docs and versioning. The example below is for release 0.6.0.

  • Update the version
    • In pyproject.toml
    • Rename doc/changes/latest.rst to 0.6.rst
    • In doc/changes/index.rst, remove latest.rst in favor of 0.6.rst
    • Merge the changes
  • Build the documentation localy
  • Checkout the gh-pages branch
    • Rename stable to 0.5
    • Copy the build documentation to stable (the dev folder will be overwritten later)
    • Push the changes
  • Create a new release
    • Tag and title name is v0.6.0
    • In the Actions, make sure the publication workflow succeeded. If the workflow failed, fix the failure and trigger the workflow manually.
  • Checkout and push a new branch maint/0.6 from the most recent commit
  • Update the version to the next dev
    • In pyproject.toml
    • Remove sphinx tag .. _latest in 0.6.rst
    • Copy and edit latest.rst from template
    • Add latest.rst to doc/changes/index.rst
    • Update versions in doc/_static/versions.json
  • conda-forge should automatically open a PR to update the feedstock
Clone this wiki locally