Skip to content

How to create a new release

Jump to bottom
Alyssa Travitz edited this page Feb 26, 2025 · 12 revisions

Release Process: Overview

First we create a release on GitHub, then we make a release on conda-forge. Once that process is done we can make the container images and single file installers.

Create the release PR

Make the PR:

  1. Create a new release-prep branch corresponding to the version name, e.g. release-prep-v1.2.0. Note: please follow semantic versioning.
  2. Check that all user-relevant updates are included in the news/ rever .rst files. You can backfill any additional items by making a new .rst, e.g. backfill.rst
  3. Run rever, e.g. rever 1.2.0. This will auto-commit docs/CHANGELOG.md and remove the .rst files from news/.
  4. Verify thatdocs/CHANGELOG.md looks correct.
  5. Make the PR and verify that CI/CD passes.
  6. Merge the PR into main.

Create Release on Github

  1. Create a release on Github
  2. The title should be the version, e.g. v0.10.1
  3. Select "Choose Tag" and type in the new version, and click "Create new tag ... on publish"

image

  1. Then click "Generate Release Notes"
  2. Add the link to the openfe website changelog in the release notes.
  3. Add a few sentences to summarize the changes (for example, if there is a major API change, it can be helpful to add a section telling users how to migrate to new API).

Create Release on Conda-Forge

Either wait for the conda-forge bot to pickup the new version (example) or create a pull request (example).

Create Docker and Apptainer Images

  1. Wait for the conda-forge release process to finish.
  2. Check here to see if the new version shows up.
  3. Once the version shows up, go here and click the "Run workflow" button, select the tag that you created for the release (on the tab next to branch) and then click "Run workflow" button.

image

  1. After the workflow finishes, the images should show up here

Create Single File Installers

  1. Wait for the conda-forge release process to finish.
  2. Check here to see if the new version shows up.
  3. Once the version shows up, go here and click the "Run workflow" button, select the tag that you created for the release (on the tab next to branch) and then click "Run workflow" button.

image

Note: The workflow now should automatically upload the single file installer, so the next steps are not needed.

  1. Once the workflow finishes (both jobs need to finish) go to the "Summary" page for the workflow:

image

  1. Then scroll down to the "Artifacts" section (Note: Even if the Linux job finishes, the artifacts will not show up until both jobs are done)

image

  1. Download both artifacts and unzip them.
  2. Go back to the release you just made and click "Edit"

image

  1. Either drag the unzipped files into the box, or click the gray box to open a selection window for the files

image

  1. Wait for the files to finish uploading, then click "Update Release"

  2. Make a PR into the example notebooks repository to update the version used in showcase/openfe_showcase.ipynb and .binder/environment.yml

Clone this wiki locally