54 lines
1.6 KiB
ReStructuredText
54 lines
1.6 KiB
ReStructuredText
Doing a release
|
|
===============
|
|
|
|
Doing a release of ``lemur`` requires a few steps.
|
|
|
|
Bumping the version number
|
|
--------------------------
|
|
|
|
The next step in doing a release is bumping the version number in the
|
|
software.
|
|
|
|
* Update the version number in ``lemur/__about__.py``.
|
|
* Set the release date in the :doc:`/changelog`.
|
|
* Do a commit indicating this, and raise a pull request with this.
|
|
* Wait for it to be merged.
|
|
|
|
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 <https://pypi.org/manage/account/#api-tokens>`_,
|
|
which requires permissions to maintain the Lemur `project <https://pypi.org/project/lemur/>`_.
|
|
|
|
``python3 -m pip install --user --upgrade twine``
|
|
``python3 -m twine upload --repository pypi dist/*``
|
|
|
|
The release should now be available on PyPI and a tag should be available in
|
|
the repository.
|
|
|
|
Verifying the release
|
|
---------------------
|
|
|
|
You should verify that ``pip install lemur`` works correctly:
|
|
|
|
.. code-block:: pycon
|
|
|
|
>>> import lemur
|
|
>>> lemur.__version__
|
|
'...'
|
|
|
|
Verify that this is the version you just released.
|
|
|
|
Post-release tasks
|
|
------------------
|
|
|
|
* Update the version number to the next major (e.g. ``0.5.dev1``) in
|
|
``lemur/__about__.py`` and
|
|
* Add new :doc:`/changelog` entry with next version and note that it is under
|
|
active development
|
|
* Send a pull request with these items
|
|
* Check for any outstanding code undergoing a deprecation cycle by looking in
|
|
``lemur.utils`` for ``DeprecatedIn**`` definitions. If any exist open
|
|
a ticket to increment them for the next release.
|