Skip to content

Releasing

R. Bernstein edited this page Dec 18, 2025 · 1 revision

Get latest sources:

$ git pull

Change version in timed_threads/version.py

Update __version__ in timed_threads/version.py.

$ source timed_threads/version.py # to set in POSIX shell
$ echo $__version__

Make release branch:

$ git checkout -b release-$__version__
$ git commit -m"Get ready for release $__version__" .

Update Changes

$ make ChangeLog
$ codespell ChangeLog

If ChangeLog has spelling typos, make the corrections and:

$ cp ChangeLog ChangeLog-spell-corrected
$ mv ChangeLog.orig ChangeLog
$ diff -u ChangeLog ChangeLog-spell-corrected

If the diff looks like it captures the corrections:

$ diff -u ChangeLog ChangeLog-spell-corrected > ChangeLog-spell-corrected.diff

Update CHANGES.rst from ChangeLog.

$ make check
$ git commit --amend .
$ git push   # get CI testing going early

Check the package from GitHub

Todo: turn this into a script in admin-tools

$ [[ ! -d /tmp/gittest ]] && mkdir /tmp/gittest; pushd /tmp/gittest
$ pyenv local 3.11.5
$ pip install -e git+https://github.com/Mathics3/timed_threads.git#egg=timed_threads
$ cd time_thread && make check
$ popd

Make packages and check

$ ./admin-tools/check-versions.sh
$ ./admin-tools/make-dist.sh
$ twine check dist/timed_threads-$__version__*

Release on Github

Goto https://github.com/Mathics3/timed_threads/releases/new

Now check the tagged release. (Checking the untagged release was previously done).

Todo: turn this into a script in admin-tools

$ git pull # to pull down new tag
$ pushd /tmp/gittest
$ pip install -e git+https://github.com/Mathics3/timed_threads.git@${__version__}#egg=timed_threads
$ timed_threads --version
$ timed_threads -c '1+2'
$ pip uninstall timed_threads
$ popd

Upload the release to PyPI

Upload it to PyPI with twine

$ twine upload dist/timed_threads-${__version__}*

Move uploaded versions to dist/uploaded.

Post-Release

  • Update __version__ to NEXT_VERSION.dev0