Releasing

Making a Mathics3 Kernel Release

Note: This package depends on ``mathics-scanner``, so if that needs a release too, do that before this.

Check to see if we use newer releases of numpy, sympy, scipy, etc.

Look over https://pypi.org/project/Mathics3/ to see that the page renders properly. Update or fix if necessary.

$ PACKAGE="Mathics3"
$ github_top_dir="mathics-core"
# Edit mathics/version.py
$ source mathics/version.py # to set in POSIX shell
$ echo $__version__

Mathics3 Kernel Workflows update?

Check .github/workflows/*.yml to make see if we are using github versions (of scanner) for testing. If so adjust.

Create a new Mathics3 Kernel branch

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

Update Mathics3 Kernel Changes

$ make ChangeLog
$ codespell ChangeLog
# Fix errors and rename to ChangeLog.spell-corrected
$ mv -v ChangeLog.orig ChangeLog
$ diff -u ChangeLog ChangeLog.spell-corrected > ChangeLog-spell-corrected.diff

Update CHANGES.rst from ChangeLog

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

Make Mathics3 PDF (optional)

This step can be deferred until Mathics3 Modules are updated

$ pyenv local 3.12 # or whatever latest Python you want to build doc with
$ make clean
$ make doc

Look at resulting PDF and colophon

Copy PDF to mathics.github.io

Check Mathics3 Kernel Python versions

$ ./admin-tools/check-versions.sh

Merge Mathics3 Kernel Release

Go to github and merge release into master.

Then... .. code::

$ git checkout master
$ git pull

Check Mathics3 Kernel package from github

TODO: turn this into a script in admin-tools

$ [[ ! -d /tmp/gittest ]] && mkdir /tmp/gittest; pushd /tmp/gittest
$ pyenv local 3.12.6 # Use a version that is not the most recent
$ pip install -e git+https://github.com/Mathics3/${github_top_dir}.git#egg=${PACKAGE}
$ mathics --version # see that new version appears
$ mathics -e "1+2"
$ pip uninstall ${PACKAGE}
$ popd

Make Mathics3 Kernel packages and check

$ python -m build
$ twine check dist/[Mm]athics3-$__version__*

Go over what is in dist and remove unnecessary files in dist.

Install wheel:

$ pyenv local 3.12.7 # not a latest version
$ pip install dist/Mathics3-${__version__}-py3-none-any.whl
$ tar -C /tmp/gittest -xpf dist/mathics3-${__version__}.tar.gz
$ cd /tmp/gittext/mathcs3-{__version__} && make check

Look over what's installed and try a make test using that version.

Release Mathics3 Kernel on Github

Go to https://github.com/Mathics3/mathics-core/releases/new

https://cloudconvert.com/rst-to-md can be used to change the CHANGES.rst section to markdown.

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/${github_top_dir}.git@${__version__}#egg=${PACKAGE}
$ python -c 'import mathics_pygments; print(mathics_pygments.__version__)'
$ pip uninstall ${PACKAGE}
$ popd

Upload the Mathics3 Kernel release to PyPI

Upload it to PyPI with twine:

$ twine upload --verbose dist/$PACKAGE-${__version__}*{whl,gz}

Move Mathics3 Kernel dist files to uploaded

$ [[ ! -d dist/uploaded ]] || mkdir dist/uploaded
$ mv -v dist/$PACKAGE*{whl,gz} dist/uploaded/

Post Mathics3 Kernel Release

Add 1 to release number of version in mathics/version.py; also append "dev0".