CADET-RDM Release Checklist

Release v1.2.0 is prepared in stack #149: #148 (GitHub create_remotes fix and configurable API tests), then #135 (version bump) before the GitHub release is published.

CADET-RDM follows the semantic versioning system described at semver.org.

CADET-RDM is released from the main branch and deployed to PyPI via a GitHub workflow automatically.

The following checklist describes the steps to execute sequentially for creating a new release.

Preparation

• Ensure that CI passes on main, including the Ruff workflow.
• Create a release branch release/v1.2.0 from main.
• Create a version bump commit Bump version to v1.2.0:
  • Update the version number in
  • cadetrdm/__init__.py
  • .zenodo.json (two places: title and version)
• Update .zenodo.json if authorship or other metadata changed.
• Run the tests that CI does not run, which need network access and API tokens (GitHub API tests pass with Fix create_remotes on GitHub and make the API tests configurable #148; GitLab skipped, no token):

  pytest tests -m "slow or server_api"

  The API tests need the account variables from CONTRIBUTING.md once Fix create_remotes on GitHub and make the API tests configurable #148 is merged.
• Open a pull request from the release branch onto main and merge it.

Creating the release on GitHub

• Go to GitHub Releases:
  • Set main as the target
  • Specify the tag v1.2.0 according to semantic versioning
  • Add release notes with sections for Added, Fixed, Changed, and Updated
  • Publish the release.
• Verify Zenodo archiving:
  • Confirm that a version-specific DOI was created
  • Ensure that the source code and associated files are archived
  • Note that the concept DOI remains constant

Deployment on PyPI

• Check if the GitHub action with workflow file release.yml ran successfully, fix if required.
• Check the new version on the PyPI CADET-RDM website.
• Check that the documentation was built for the new version.

Follow-up

• If this release checklist was updated, add these changes to the corresponding issue template