mirror of
https://github.com/saymrwulf/cryptography.git
synced 2026-05-14 20:37:55 +00:00
63b3de2fa8
Which is usually for descriptive clauses in technical writing, while that is restrictive. Most of the time we are being being restrictive.
37 lines
1 KiB
ReStructuredText
37 lines
1 KiB
ReStructuredText
Doing a Release
|
|
===============
|
|
|
|
Doing a release of ``cryptography`` is a two part process.
|
|
|
|
Bumping the version number
|
|
--------------------------
|
|
|
|
The first step in doing a release is bumping the version number in the
|
|
software.
|
|
|
|
* Update the version number in ``cryptography/__about__.py``.
|
|
* Set the release date in the :doc:`/changelog`.
|
|
* Do a commit indicating this.
|
|
* Send 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 will need to have ``gpg`` installed and a ``gpg``
|
|
key in order to do a release. Once this has happened:
|
|
|
|
* Run ``invoke release {version}``.
|
|
|
|
The release should now be available on PyPI and a tag should be available in
|
|
the repository. You should verify that ``pip install cryptography`` works
|
|
correctly:
|
|
|
|
.. code-block:: pycon
|
|
|
|
>>> import cryptography
|
|
>>> cryptography.__version__
|
|
'...'
|
|
|
|
Verify that this is the version you just released.
|