Skip to content

Commit 0384c41

Browse files
committed
docs(readme): update release instructions
1 parent ffa29e8 commit 0384c41

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,31 @@ TODO
6161
Release
6262
-------
6363

64-
Steps to perform a release:
64+
Steps to perform a release: https://tree-sitter.github.io/tree-sitter/creating-parsers/6-publishing.html
6565

66-
1. Bump and tag the version:
67-
68-
**First** bump `Cargo.toml`, `pyproject.toml`, and `Makefile` to the new version. **Then** bump the package:
69-
```bash
70-
npm version patch -m "release %s"
66+
1. Update tree-sitter CLI.
7167
```
72-
73-
Choose `patch`/`minor`/`major` to indicate query compatibility:
74-
- `patch` for bugfixes (no changes to queries needed)
75-
- `minor` for added nodes (queries may need changes to use new nodes but will not error)
76-
- `major` for removed or renamed nodes (queries will error if not adapted), other breaking changes
77-
78-
2. Bump to prerelease, without creating a tag:
79-
```bash
80-
npm version --no-git-tag-version prerelease --preid dev
81-
git add package*.json Cargo.toml pyproject.toml Makefile
82-
git commit -m bump
68+
npm install tree-sitter-cli
69+
```
70+
2. Bump the version.
71+
```
72+
tree-sitter version x.y.z
73+
```
74+
- Choose `patch`/`minor`/`major` to indicate query compatibility:
75+
- `patch` for bugfixes (no changes to queries needed)
76+
- `minor` for added nodes (queries may need changes to use new nodes but will not error)
77+
- `major` for removed or renamed nodes (queries will error if not adapted), other breaking changes
78+
3. Regenerate and test.
79+
```
80+
tree-sitter generate && tree-sitter test
81+
```
82+
4. Commit the generated files
83+
```
84+
git add .
85+
git commit -m 'release'
86+
```
87+
5. Push
8388
```
84-
3. Push:
85-
```bash
86-
git push && git push --tags
89+
git push
8790
```
88-
4. Release the tagged commit: https://github.com/neovim/tree-sitter-vimdoc/releases/new
91+
6. Tag and release: https://github.com/neovim/tree-sitter-vimdoc/releases/new

0 commit comments

Comments
 (0)