From b74b6de37a4bdab65d624cae399b464a07fbd2de Mon Sep 17 00:00:00 2001 From: Simon Bennetts Date: Fri, 12 Jun 2026 14:36:15 +0100 Subject: [PATCH] Prepare 0.6.0 And fix the release doc Signed-off-by: Simon Bennetts --- CHANGELOG.md | 4 ++-- RELEASING.md | 30 ++++++++++++++++++++++++++---- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d97b4a..4a58d07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). -## [Unreleased] +## [0.6.0] - 2026-06-12 ### Changed - Added support for 'method' parameter on Replacer 'add_rule' @@ -211,7 +211,7 @@ ensure it's automatically sent in all API requests. ### Changed - Moved from the main `zaproxy` repository. -[Unreleased]: https://github.com/zaproxy/zap-api-python/compare/0.5.0...HEAD +[0.6.0]: https://github.com/zaproxy/zap-api-python/compare/0.5.0...0.6.0 [0.5.0]: https://github.com/zaproxy/zap-api-python/compare/0.4.0...0.5.0 [0.4.0]: https://github.com/zaproxy/zap-api-python/compare/0.3.2...0.4.0 [0.3.2]: https://github.com/zaproxy/zap-api-python/compare/0.3.1...0.3.2 diff --git a/RELEASING.md b/RELEASING.md index db9379b..3ac1196 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,13 +1,35 @@ -### Release to PyPi +## Releasing + +Example commands use the version `0.x.0`, it should be replaced accordingly to the version being released. + +### Update the Changelog + +Change `## [Unreleased]` to `## [0.x.0] - yyyy-mm-dd` -Example commands use the version `0.0.X`, it should be replaced accordingly to the version being released. +Change `[Unreleased]: ...HEAD` to `[0.x.0] ...0.x.0` + +Submit a PR and wait for it to be merged. + +### Release to PyPi Ensure the version is right in `pyproject.toml`. Tag (and push) the new version: - git tag -s 0.0.X -m "Version 0.0.X." - git push upstream 0.0.X + git tag -s 0.0.X -m "Version 0.x.0" + git push upstream 0.x.0 The workflow [Release PyPI](https://github.com/zaproxy/zap-api-python/blob/main/.github/workflows/release.yml) will be triggered by the tag push and release to PyPI. + +### Update for the Next Version + +Increment the version in `pyproject.toml` + +Increment the version in `src/zapv2/__init__.py` + +Add a new `## [Unreleased]` section at the top + +Add a new `[Unreleased]: 0.x.0...HEAD` section at the start of the last section + +Submit a PR and wait for it to be merged.