diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 747668fb..8e24e7c1 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -1,10 +1,18 @@ Doing a release =============== -Doing a release of ``lemur`` requires a few steps. +Doing a release of ``lemur`` is now mostly automated and consists of the following steps: -Bumping the version number --------------------------- +* Raise a PR to add the release date and summary in the :doc:`/changelog`. +* Merge above PR and create a new `Github release `_: set the tag starting with v, e.g., v0.9.0 + +The `publish workflow `_ uses the git +tag to set the release version. + +The following describes the manual release steps, which is now obsolete: + +Manually Bumping the version number +----------------------------------- The next step in doing a release is bumping the version number in the software. @@ -14,8 +22,8 @@ software. * Do a commit indicating this, and raise a pull request with this. * Wait for it to be merged. -Performing the release ----------------------- +Manually Performing the release +------------------------------- The commit that merged the version number bump is now the official release commit for this release. You need an `API key `_,