Skip to content

Commit 54d1e91

Browse files
Drop in-repo changelog
Release notes live on GitHub Releases; remove CHANGELOG.md and its gate test. Co-authored-by: Jared Lunde <jared.lunde@gmail.com>
1 parent 16fa4ce commit 54d1e91

4 files changed

Lines changed: 3 additions & 390 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 201 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Rustwright is an alpha Rust/PyO3 project with a Playwright-shaped Python API.
44
Expect some rough edges, large files, and compatibility behavior that is still
55
being proven.
66

7-
PRs with user-facing changes should add a bullet under `## [Unreleased]` in `CHANGELOG.md`.
8-
97
## Local Setup
108

119
Use a virtual environment and build the native extension with maturin:

docs/RELEASING.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ attaching binaries to the GitHub Release — not registry Trusted Publishing.
2929
- `python/rustwright/cli.py` → source-checkout fallback in `_version`
3030
- `python/rustwright/_backend.py` → source-checkout fallback in `_version` (before `+local`)
3131
- `python/rustwright/_agent/cli.py` → source-checkout fallback
32-
- [ ] Add a `## [<version>] - <date>` section to `CHANGELOG.md` by renaming the
33-
current `## [Unreleased]` section and opening a fresh empty one above it,
34-
add the matching link reference at the bottom, and add the version to
35-
`REQUIRED_VERSIONS` in `tests/test_changelog.py`.
3632
- [ ] Regenerate the lockfiles; do not edit generated entries by hand. There are
3733
three Cargo lockfiles, because `cli/` and `mcp/` are separate workspaces
3834
that depend on `rustwright-core` by path — the root `cargo` command does
@@ -50,7 +46,7 @@ attaching binaries to the GitHub Release — not registry Trusted Publishing.
5046
- [ ] Confirm nothing was missed:
5147

5248
```bash
53-
git grep -n "$PREVIOUS_VERSION" -- . ':!CHANGELOG.md' ':!docs/'
49+
git grep -n "$PREVIOUS_VERSION" -- . ':!docs/'
5450
```
5551

5652
- [ ] Run local release checks:
@@ -68,7 +64,8 @@ attaching binaries to the GitHub Release — not registry Trusted Publishing.
6864
- [ ] Tag the merge commit `v${VERSION}` and push the tag.
6965
- [ ] Build release binaries for the supported targets (at least the
7066
`rustwright-cli-<target>` names expected by `install.sh`).
71-
- [ ] Create a GitHub Release for the tag and upload those assets.
67+
- [ ] Create a GitHub Release for the tag and upload those assets. Put release
68+
notes on the GitHub Release itself (there is no in-repo changelog).
7269
- [ ] Confirm `install.sh` (or an equivalent curl install path) downloads the
7370
new CLI asset successfully on a clean machine.
7471

0 commit comments

Comments
 (0)