diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..065df34 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,47 @@ +# Changelog + +## [1.12.0](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.11.0...v1.12.0) (2026-10-30) + + +### Features + +* **crawl:** get notified by webhook when a crawl starts, completes, stops or fails ([#72](https://github.com/ZenRows/zenrows-python-sdk/issues/72)) ([42a6e37](https://github.com/ZenRows/zenrows-python-sdk/commit/42a6e378a49590ae57d8f29e10a6d86d7a693640)) + +## [1.11.0](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.10.0...v1.11.0) (2026-10-20) + + +### Features + +* **extract:** remove the autoparse fallback and add domain preparation ([#54](https://github.com/ZenRows/zenrows-python-sdk/issues/54)) ([bd47d9e](https://github.com/ZenRows/zenrows-python-sdk/commit/bd47d9e80c2b58c759c08c7eaf5fd85c6db54701)) + +## [1.10.0](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.9.1...v1.10.0) (2026-10-20) + + +### Features + +* **batch:** verify webhook signatures, skip expired results and match the API's responses ([#65](https://github.com/ZenRows/zenrows-python-sdk/issues/65)) ([d954742](https://github.com/ZenRows/zenrows-python-sdk/commit/d954742db5b0944b739dae87954ee1cc0098d433)) + +## [1.9.1](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.9.0...v1.9.1) (2026-10-19) + + +### Bug Fixes + +* **crawl:** send zenrows/<version> python from the Crawl client ([#63](https://github.com/ZenRows/zenrows-python-sdk/issues/63)) ([b397bb6](https://github.com/ZenRows/zenrows-python-sdk/commit/b397bb6765bf348ac1b20535d0058aded52ef2e8)) + +## [1.9.0](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.8.0...v1.9.0) (2026-10-16) + + +### Features + +* **crawl:** read the discovery strategies a crawl ran with, and save a page as a file ([#49](https://github.com/ZenRows/zenrows-python-sdk/issues/49)) ([8f1aa10](https://github.com/ZenRows/zenrows-python-sdk/commit/8f1aa10136830ba248c8727337b961bda554bfd7)) + +## [1.8.0](https://github.com/ZenRows/zenrows-python-sdk/compare/v1.7.0...v1.8.0) (2026-10-14) + + +### Features + +* **crawl:** accept markdown as an output format ([#44](https://github.com/ZenRows/zenrows-python-sdk/issues/44)) ([1592826](https://github.com/ZenRows/zenrows-python-sdk/commit/1592826e3d9d78332d6148c793aca51413087770)) + +## Older releases + +Releases before 1.8.0 are listed on [GitHub Releases](https://github.com/ZenRows/zenrows-python-sdk/releases). diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index e06c5b6..f17b800 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -141,7 +141,15 @@ Merge PRs with Conventional Commit titles, for example `fix(crawl): ...` or After each merge to `main`, release-please opens or updates the PR `chore: release X.Y.Z`. It sets the version in `pyproject.toml`, -`src/zenrows/__version__.py` and `uv.lock`. Do not change these by hand. +`src/zenrows/__version__.py` and `uv.lock`, and adds the release's entry at +the top of `CHANGELOG.md`. Do not change these by hand. + +To flag a change in behaviour that callers must know about, end the PR body +with a `BEGIN_COMMIT_OVERRIDE` / `END_COMMIT_OVERRIDE` block before you merge. +Each line in it becomes one changelog entry. A line such as +`behaviour(client): ...` lands under "Behaviour Changes", at the top of the +release entry. Next to a `feat` or `fix` line, it does not bump the +version on its own. A `behaviour` line alone still makes a patch release. To release, merge that PR. The workflow runs the checks, creates the tag `vX.Y.Z` and the GitHub release, and publishes to PyPI. diff --git a/release-please-config.json b/release-please-config.json index 630d62f..b2a5905 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -2,9 +2,13 @@ "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json", "release-type": "python", "include-component-in-tag": false, - "skip-changelog": true, + "skip-changelog": false, "pull-request-title-pattern": "chore: release ${version}", "changelog-sections": [ + { + "type": "behaviour", + "section": "Behaviour Changes" + }, { "type": "feat", "section": "Features"