diff --git a/CHANGELOG.md b/CHANGELOG.md index d0a25bc..ac7ee8a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +## v2.0.2 (2024-11-26) + - Add testing for Wagtail 6.3 & 7.0 - Use python 3.13 across workflows and formatting diff --git a/README.md b/README.md index bf21de6..b3fcd2c 100644 --- a/README.md +++ b/README.md @@ -157,3 +157,15 @@ class DirectDebitDeclarationAnonymiser(BaseModelAnonymiser): - `processors.users.UserPasswordAnonymiser` - replaces user passwords with random UUIDs - `processors.contrib.wagtail.SearchQueryCleaner` - removes the full search query history - `processors.contrib.wagtail.FormSubmissionCleaner` - removes all form submissions + + +## Making a new release + +The release process is automated using GitHub Actions. To prepare a new release: + +1. Create a new branch from `main` called `release/vX.Y.Z` where `X.Y.Z` is the new version number. +2. Update the `__version__` variable in `birdbath/__init__.py` to match the new version number. +3. Update `CHANGELOG.md` to add a new section for the new version, including a date and a list of changes. +4. Commit and push the branch to GitHub. +5. Open a pull request against `main` and merge it once approved. +6. Create a new release on GitHub using the new version number and the changelog entries as the release notes. This will trigger the GitHub Actions workflow to build and publish the new package to PyPI. \ No newline at end of file diff --git a/birdbath/__init__.py b/birdbath/__init__.py index ee3bd92..8e8d4c9 100644 --- a/birdbath/__init__.py +++ b/birdbath/__init__.py @@ -3,6 +3,6 @@ don't need in your development environment, or whatever it is you need to do. """ -__version__ = "2.0.1" +__version__ = "2.0.2" default_app_config = "birdbath.apps.BirdBathConfig"