Releasing a new version of Splink¶

Splink is regularly updated with releases to add new features or bug fixes to the package.

Below are the steps for releasing a new version of Splink:

On a new branch, update pyproject.toml and init.py with the latest version.
Update CHANGELOG.md. This consists of adding a heading for the new release below the 'Unreleased' heading, with the new version and date. Additionally the links at the bottom of the file for 'unreleased' and the new version should be updated.
Open a pull request to merge the new branch with the master branch (the base branch).
Once the pull request has been approved, merge the changes and generate a new release in the releases section of the repo, including:
Choosing a new release tag (which matches your updates to pyproject.toml and init.py). Ensure that your release tag follows semantic versioning. The target branch should be set to master.

)

Generating release notes. This can be done automatically by pressing the button.

This will give you release notes based off the Pull Requests which have been merged since the last release.

For example

Now your release should be published to PyPI.