Skip to content

Creating and deploying a release

Matthew Evans edited this page Nov 9, 2023 · 5 revisions

We now use lots of fancy automated release processes in this repository. Releasing should be as easy as making a semver release on GH, with the desired version. This will trigger a GH action to update the version in the source code, regenerate the OpenAPI schema, generate an automatic changelog and push all this to master and release to PyPI.

If things go wrong during the release for non-code reasons, e.g., (as just happened to me), the autogenerated CHANGELOG does not pass the linter, due to additional whitespace in the GitHub issue... then all ephemeral data should be updated and the overall release workflow can be re-triggered.

If desired, release notes can be added to the changelog by creating an issue with the label release-summary, and add it to a milestone that matches the tag name for the release. The issue body will then be added to the start of the changelog.

Clone this wiki locally