Tutorial: how to prepare a release

[diegoferigo]

• Resolve conflicts merging master into devel, if needed. db069ff
• Merge devel into master, making sure that everything works as expected.
• Bump the ScenarIO version in the top-level CMakeLists.txt.
• Make sure that scenario.__init__.py defines the correct specifier set for the Ignition distribution.
• Check if any dependency under our control has to be bumped, or if any dependency version has to be updated in setup.py, setup.cfg, and pyproject.toml.
• Create a new GitHub pre-release with a new tag v*.rc0¹ and make sure that is properly deployed to PyPI. This is necessary for the next step.
• Bump the scenario specifier set in the setup.cfg of gym-ignition in master (e.g. ~= 1.3.1.rc for the 1.3.1 release). It makes all gym_ignition packages compatible only with scenario packages that share the same minor version.
• Create a new GitHub release with a new tag v*¹.
• Make sure that the release was successfully uploaded in PyPI in both sdist and wheel formats.
• Bump the scenario specifier set in the setup.cfg of gym-ignition in devel by increasing the least significant number (e.g. >= 1.3.2.dev for the 1.3.1 release, or >= 1.3.1post1.dev for the 1.3.1.post0 release). It makes nightly releases incompatible with stable versions, making sure that calling pip install --pre gym_ignition pulls the pre-release also of scenario.
• Merge master into devel. This merge must contain the commit associated to the release tag in order to reset the automatic numbering of the pre-release packages of the nightly branch. If a post-release has to be published to fix minor errors, master has to be merged again into devel.

Remember: once a package is uploaded to PyPI, there's no way back, it cannot be overridden. If something happens, create either a post-release or a new patch release.

If it can help, this is a visual example of the intended outcome

Footnotes

1. Note that the version without the v prefix must comply with PEP440 in this regexp. ↩ ↩²