Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
30 changes: 26 additions & 4 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -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]: <link>...HEAD` to `[0.x.0] <link>...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]: <link>0.x.0...HEAD` section at the start of the last section

Submit a PR and wait for it to be merged.