Releasing

This document describes the steps to release a new version of DNSimple/Python.

Prerequisites

Determine the new version using Semantic Versioning
```
VERSION=X.Y.Z
```
- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes
Check the ## Unreleased section in CHANGELOG.md for entries prefixed with **BREAKING**:. Any such entry requires a MAJOR version, whatever the other entries are. Raising the minimum supported Python version is always a breaking change, so its changelog entry must carry this prefix.
Update the version files with the new version

Edit ./dnsimple/version.py and pyproject.toml:
```
version = "$VERSION"
```
Run tests and confirm they pass
```
make test
```
Update the changelog with the new version

Finalize the ## Unreleased section in CHANGELOG.md assigning the version.
Commit the new version
```
git commit -a -m "Release $VERSION"
```
Push the changes
```
git push origin main
```
Wait for CI to complete

Create a signed tag

git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags