Skip to content

Commit f5d0d08

Browse files
ObserverOfTimeclason
authored andcommitted
docs(readme): update release instructions
1 parent 548b021 commit f5d0d08

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,23 @@ Release
6464
Steps to perform a release:
6565

6666
1. Bump and tag the version:
67-
```
67+
```bash
6868
npm version patch -m "release %s"
6969
```
7070
Choose `patch`/`minor`/`major` to indicate query compatibility:
7171
- `patch` for bugfixes (no changes to queries needed)
7272
- `minor` for added nodes (queries may need changes to use new nodes but will not error)
7373
- `major` for removed or renamed nodes (queries will error if not adapted), other breaking changes
74+
75+
Ensure that `Cargo.toml`, `pyproject.toml`, and `Makefile` also have the same version.
7476
2. Bump to prerelease, without creating a tag:
75-
```
76-
npm version --no-git-tag-version prerelease --preid dev && git add package*.json && git commit -m bump
77+
```bash
78+
npm version --no-git-tag-version prerelease --preid dev
79+
git add package*.json Cargo.toml pyproject.toml Makefile
80+
git commit -m bump
7781
```
7882
3. Push:
79-
```
80-
git push --follow-tags
83+
```bash
84+
git push && git push --tags
8185
```
8286
4. Release the tagged commit: https://github.com/neovim/tree-sitter-vimdoc/releases/new

0 commit comments

Comments
 (0)