2018-06-27 13:11:36 +02:00
|
|
|
=================
|
|
|
|
|
Release procedure
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
This document is a checklist for creating a toot release.
|
|
|
|
|
|
|
|
|
|
Currently the process is pretty manual and would benefit from automatization.
|
|
|
|
|
|
|
|
|
|
Bump & tag version
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
* Update the version number in ``setup.py``
|
|
|
|
|
* Update the version number in ``toot/__init__.py``
|
2019-09-03 16:39:06 +02:00
|
|
|
* Update ``changelog.yaml`` with the release notes & date
|
2020-04-15 14:28:17 +02:00
|
|
|
* Run ``make changelog`` to generate a human readable changelog
|
2019-09-03 16:39:06 +02:00
|
|
|
* Commit the changes
|
2020-01-23 13:24:49 +01:00
|
|
|
* Run ``./scripts/tag_version <version>`` to tag a release in git
|
2022-11-09 14:24:48 +01:00
|
|
|
* Run ``git push --follow-tags`` to upload changes and tag to GitHub
|
2018-06-27 13:11:36 +02:00
|
|
|
|
|
|
|
|
Publishing to PyPI
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
* ``make dist`` to create source and wheel distributions
|
|
|
|
|
* ``make publish`` to push them to PyPI
|
|
|
|
|
|
2022-11-09 14:24:48 +01:00
|
|
|
GitHub release
|
2018-06-27 13:11:36 +02:00
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
* `Create a release <https://github.com/ihabunek/toot/releases/>`_ for the newly
|
|
|
|
|
pushed tag, paste changelog since last tag in the description
|
|
|
|
|
* Upload the assets generated in previous two steps to the release:
|
|
|
|
|
* source dist (.zip and .tar.gz)
|
|
|
|
|
* wheel distribution (.whl)
|
2019-09-03 16:39:06 +02:00
|
|
|
|
|
|
|
|
TODO: this can be automated: https://developer.github.com/v3/repos/releases/
|
