Create a new release

How to create a new release

1. Check out the develop branch

git checkout develop && git pull

2. Edit documentation for the new version

Change the versions from the old to the new ones in these files:

• in docs/source/conf.py
• in docs/source/cli.rst

Commit these files with the message Bump version to X.Y.Z (replace X.Y.Z with the new version) and push. This commit may be done directly on the develop branch.

3. Merge from develop into main

• Create a pull request (click!) from develop into main. Give it the name "Release X.Y.Z"
• Merge it (DON'T SQUASH!, use a merge commit)

4. Create a new release

Then go to the https://github.com/sodascience/metasyn/releases page on GitHub and push the Draft a new release button at the top.

Create a new tag from the main branch with the new version, e.g., like so:

Use the title Version X.Y.Z. You should then summarize the major/minor changes in the release text, feel free to use the autofill but also describe it in natural language.

5. Rebase develop on main and push with the new tag

git fetch
git checkout develop
git rebase main
git push