Releasing

Table of Contents

• Get latest sources:
• Check that Mathics3 isn't broken with this code:
• Change version in mathics/version.py
• Make release branch:
• Update Changes
• Create PR and check CI on github.
• Check package from github
• Make packages and check
• Release on Github
• Upload the release to PyPI
• Post-Release

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.

Check that Mathics3 isn't broken with this code:

$ make check-mathics

Change version in mathics/version.py

Update __version__ in mathics_scanner/version.py.

$ source mathics_scanner/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
$ 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 .

http://rst.ninjs.org/ can be used for checking the RsT.

Go over spelling with codespell.

$ git push  -u origin HEAD # get CI testing going early

Create PR and check CI on github.

$ git checkout master
$ git pull origin HEAD

Check package from github

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/mathics-scanner.git#egg=mathics-scanner
$ (cd /tmp/gittest/src/mathics-scanner/ && make)
$ python -m mathics_scanner.generate.rl_inputrc inputrc-no-unicode
$ mathics3-tokens --version  # see that version number is correct
$ echo '\( Rowbox[\\[theta] \+  "2" \)' | mathics3-tokens
$ pip uninstall mathics-scanner
$ popd

Make packages and check

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

Release on Github

Goto https://github.com/mathics3/mathics-scanner/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/mathics-scanner.git@${__version__}#egg=mathics-scanner
$ (cd /tmp/gittest/src/mathics-scanner/ && make)
$ python -m mathics_scanner.generate.rl_inputrc inputrc-no-unicode
$ pip uninstall mathics-scanner
$ popd

Upload the release to PyPI

Upload it to PyPI with twine

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

Move uploaded versions to dist/uploaded.

Post-Release

• Update docker setup
• Update __version__ to NEXT_VERSION.dev0