From 1d486cf1fd69dc7a37d416866004ea9fc4aafb88 Mon Sep 17 00:00:00 2001 From: Hossein Shafagh Date: Fri, 12 Mar 2021 11:49:17 -0800 Subject: [PATCH 1/2] updated docs for automated release --- docs/doing-a-release.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 747668fb..02733f89 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -1,9 +1,17 @@ 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 @@ -14,7 +22,7 @@ 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 From a0a5e66cc3a033ea4da121b651dbb2b152ef7a23 Mon Sep 17 00:00:00 2001 From: Hossein Shafagh Date: Fri, 12 Mar 2021 12:10:38 -0800 Subject: [PATCH 2/2] fixing broken doc --- docs/doing-a-release.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 02733f89..8e24e7c1 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -12,7 +12,7 @@ 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. @@ -23,7 +23,7 @@ software. * Wait for it to be merged. 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 `_,