Infra
/
lemur
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #3472 from hosseinsh/auto-release-doc 

updated docs for automated release
This commit is contained in:
Hossein Shafagh 2021-03-16 16:26:00 -07:00 committed by GitHub
parent 0175df821c a40298df08
commit c1168399a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/doing-a-release.rst
View File

@ -1,10 +1,18 @@
Doing a release 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 <https://github.com/Netflix/lemur/releaes>`_: set the tag starting with v, e.g., v0.9.0
The `publish workflow <https://github.com/Netflix/lemur/actions/workflows/lemur-publish-release-pypi.yml>`_ 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 The next step in doing a release is bumping the version number in the
software. software.
@ -14,8 +22,8 @@ software.
* Do a commit indicating this, and raise a pull request with this. * Do a commit indicating this, and raise a pull request with this.
* Wait for it to be merged. * 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 The commit that merged the version number bump is now the official release
commit for this release. You need an `API key <https://pypi.org/manage/account/#api-tokens>`_, commit for this release. You need an `API key <https://pypi.org/manage/account/#api-tokens>`_,