diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..70c8ed7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,31 @@ +# Changelog + +## [2.6.0](https://github.com/ZenRows/zenrows-node-sdk/compare/v2.5.0...v2.6.0) (2026-10-30) + + +### Features + +* **crawl:** get notified by webhook when a crawl starts, completes, stops or fails ([#63](https://github.com/ZenRows/zenrows-node-sdk/issues/63)) ([114f53a](https://github.com/ZenRows/zenrows-node-sdk/commit/114f53abdb64773582718870afe80cea218cd0a9)) + +## [2.5.0](https://github.com/ZenRows/zenrows-node-sdk/compare/v2.4.1...v2.5.0) (2026-10-20) + + +### Features + +* **extract:** remove the autoparse fallback and add domain preparation ([#49](https://github.com/ZenRows/zenrows-node-sdk/issues/49)) ([0f0f8e3](https://github.com/ZenRows/zenrows-node-sdk/commit/0f0f8e34da6bd9cd3658f908aaa32f374db18b74)) + +## [2.4.1](https://github.com/ZenRows/zenrows-node-sdk/compare/v2.4.0...v2.4.1) (2026-10-20) + + +### Bug Fixes + +* **batch:** match the Batch client to what the API returns and accepts ([#59](https://github.com/ZenRows/zenrows-node-sdk/issues/59)) ([5e13420](https://github.com/ZenRows/zenrows-node-sdk/commit/5e13420d816d1f689e9be02d176c0495752c1f81)) + +## [2.4.0](https://github.com/ZenRows/zenrows-node-sdk/compare/v2.3.0...v2.4.0) (2026-10-16) + + +### Features + +* **crawl:** return each page as Markdown, and read the discovery strategies a crawl ran with ([#47](https://github.com/ZenRows/zenrows-node-sdk/issues/47)) ([ca10fd9](https://github.com/ZenRows/zenrows-node-sdk/commit/ca10fd93e042758e7bbe12bc6b8048e114a31f16)) + +Releases before 2.4.0 are on [GitHub Releases](https://github.com/ZenRows/zenrows-node-sdk/releases). diff --git a/README.md b/README.md index 00bedfa..3c7281c 100644 --- a/README.md +++ b/README.md @@ -642,6 +642,23 @@ After each merge to `main`, release-please opens or updates the PR `chore: release X.Y.Z`. It sets the version in `package.json`. Do not change it by hand. +The release PR also adds the release's entry to `CHANGELOG.md`, one line per +`feat`, `fix`, `perf` or `revert`. When a change alters what existing callers +see, end the PR body with an override block before you merge it. Each line +becomes one changelog entry, and a `behaviour` line goes under "Behaviour +Changes", at the top of the entry: + +``` +BEGIN_COMMIT_OVERRIDE +feat(client): one line for the feature + +behaviour(client): one line for what changes for callers +END_COMMIT_OVERRIDE +``` + +A `behaviour` line does not set the version: the `feat` or `fix` line next to +it does. On its own, it still opens 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 npm. diff --git a/release-please-config.json b/release-please-config.json index 098e239..25793f0 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": "node", "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"