Making a new Release

Creating a release on GitHub

The process for creating a new release is documented here. Increment the second decimal (v0.1.0->v0.2.0) for regular releases and the third (v0.1.0->v0.1.1) for bugfixes. You don't need to create a tag on your own, as one will automatically be created for the release.

Publish to PyPI (requires maintainer permissions on PyPI)

Run git checkout <tag> to switch to the tag you created when the release was created. Then run poetry publish --build to publish to PyPI. Finally, upload the .tar.gz file generated to GitHub Release Assets. Only when the automatic fail to do it.

Note: You don't need to publish it manually it is done automatically. This documented to as an backup if that action fail.

Documentation

As long as we have an ongoing discussion about our stable branch, the default version of our documentation at https://docs.manim.community has to be changed to the latest release at https://readthedocs.org/dashboard/manimce/advanced/

Docker images

Docker images for new releases should be built and deployed to https://hub.docker.com/r/manimcommunity/manim -- basically by building a new image by running docker build -t manimcommunity/manim:v1.7.42 . from the docker directory, and then running docker push. (@behackl can grant access to the docker hub organization and repository.)

Update Changelog

Make the changelog appear correctly with the version and date updated.