Skip to content

Commit 9b293cf

Browse files
authored
Document the GHA release process (#209)
1 parent 0556f25 commit 9b293cf

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,5 +168,9 @@ or adding an exception in `data_exceptions.py`.
168168

169169
1. Make sure the code has been thoroughly reviewed and tested in a realistic production environment.
170170
1. Update ``setup.py`` and ``CHANGELOG.md``. Make sure you include any breaking changes.
171+
1. Run the [release github action](https://github.com/closeio/tz-trout/actions/workflows/release.yml) with the correct version number.
172+
173+
Alternatively, once the changes to setup.py and CHANGELOG.md are complete you can manually:
174+
171175
1. Run ``python setup.py sdist`` and ``twine upload dist/<PACKAGE_TO_UPLOAD>``.
172176
1. Push a new tag pointing to the released commit, format: ``v0.13`` for example.

0 commit comments

Comments
 (0)