How to create a release

Creating a release is a simple process that involves a few steps:

1. Prepare the release:

   1. Create a separate branch for the release. Name the branch release-x.y.z where x.y.z is the version number.

   2. Update the version number in judge0/__init__.py.

   3. Update the version number in judge0/pyproject.toml.

   4. Sync the branch with any changes from the master branch.

   5. Create a pull request for the release branch. Make sure that all tests pass.

   6. Merge the pull request.

   7. Pull the changes to your local repository and tag the commit (git tag vX.Y.Z) with the version number.

   8. Push the tags to the remote repository (git push origin master --tags).

2. Create release (notes) on GitHub.

   1. Go to the releases page on GitHub.

   2. Release title should be Judge0 Python SDK vX.Y.Z.

   3. Release notes should include a changes from the previous release to the newest release.

   4. Use the template from the repo to organize the changes.

   5. Click the Generate release notes button and use only Full Changelog section.

   6. Create the release. (“Set as a pre-release” should NOT be checked.)

3. Release on PyPI:

   1. Use the GitHub Actions workflow to create a release on PyPI.

   2. Select Run workflow and as Target repository select pypi.

   3. Click the Run workflow button.

After the release is successfully published on PyPI, create a new pull request that updates the working version in judge0/__init__.py and judge0/pyproject.toml to the minor version. Merge the pull request and you’re done! For example, if the new release was 1.2.2, the working version should be updated to 1.3.0.dev0.

You’ve successfully created a release! Congratulations! 🎉