Skip to content

Commit a75a932

Browse files
committed
docs(readme): correct bump instructions
1 parent 66f4fee commit a75a932

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,17 @@ Release
6464
Steps to perform a release:
6565

6666
1. Bump and tag the version:
67+
68+
**First** bump `Cargo.toml`, `pyproject.toml`, and `Makefile` to the new version. **Then** bump the package:
6769
```bash
6870
npm version patch -m "release %s"
6971
```
72+
7073
Choose `patch`/`minor`/`major` to indicate query compatibility:
7174
- `patch` for bugfixes (no changes to queries needed)
7275
- `minor` for added nodes (queries may need changes to use new nodes but will not error)
7376
- `major` for removed or renamed nodes (queries will error if not adapted), other breaking changes
7477

75-
Ensure that `Cargo.toml`, `pyproject.toml`, and `Makefile` also have the same version.
7678
2. Bump to prerelease, without creating a tag:
7779
```bash
7880
npm version --no-git-tag-version prerelease --preid dev

0 commit comments

Comments
 (0)