Skip to content

Releasing

Jump to bottom
rocky edited this page Apr 20, 2026 · 24 revisions

Table of Contents

Get latest sources:

$ git pull

If we are tracking an API change, check .github/workflows to see if we can use PyPI packages instead of GitHub repositories.

Change version in mathics_django/version.py

Update __version__ in mathics_django/version.py.

$ source mathics_django/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
$ head -n 200 ChangeLog | codespell -

If ChangeLog has spelling typos, make the corrections and:

$ cp ChangeLog ChangeLog-spell-corrected
$ mv -v ChangeLog.orig ChangeLog
$ diff -u ChangeLog ChangeLog.spell-corrected > ChangeLog-spell-corrected.diff
$ codespell ChangeLog
$ make 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

https://livesphinx.herokuapp.com/ can be used for checking the RsT.

Check package from github, then...

$ get checkout master
$ git pull origin HEAD

Todo: turn this into a script in admin-tools

$ [[ ! -d /tmp/gittest ]] && mkdir /tmp/gittest; pushd /tmp/gittest
$ pyenv local 3.13.5  # Not the most recent Python version in a release
$ pip install -e git+https://github.com/Mathics3/Mathics3-django.git#egg=Mathics3_django
$ cd src/mathics3-django
$ make
$ Mathics3server --version # see that new version appears
$ Mathics3server
$ pip uninstall Mathics3_django
$ popd

Make packages and check

$ ./admin-tools/make-dist.sh
$ twine check dist/mathics3_django-$__version__*
$ tar -tf dist/mathics3_django-${__version__}.tar.gz

Try out the tar or the wheel in a separate Python version

$ cd dist
$ pyenv local *not_currenv_python*
$ pip install mathics3_django-${__version__}-py3-none-any.whl
$ Mathics3Server --help
$ Mathics3Server --version
$ cd ..

Release on GitHub

Goto https://github.com/Mathics3/mathics-django/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 the new tag
$ pushd /tmp/gittest
$ pip install -e git+https://github.com/Mathics3/Mathics3-django.git@${__version__}#egg=Mathics3_django
$ cd src/mathics-django
$ Mathics3server --version # see that new version appears
$ Mathics3server
# Run "gallery" and "about", and check documentation.
$ pip uninstall Mathics3-django
$ popd

Upload the release to PyPI

Upload it to PyPI with twine

$ twine upload dist/mathics3_django-${__version__}*s

Move uploaded versions to dist/uploaded.

Post-Release

Clone this wiki locally