docs(cli): add docs on new version features
This commit is contained in:
parent
0cf217179c
commit
552ab537e8
1 changed files with 14 additions and 0 deletions
|
|
@ -17,12 +17,26 @@ This will update the version in several files, if they exist:
|
|||
* CMakeLists.txt
|
||||
* pyproject.toml
|
||||
|
||||
Alternative forms can use the version in `tree-sitter.json` to bump automatically:
|
||||
|
||||
```bash
|
||||
tree-sitter version --bump patch # patch bump
|
||||
tree-sitter version --bump minor # minor bump
|
||||
tree-sitter version --bump major # major bump
|
||||
```
|
||||
|
||||
As a grammar author, you should keep the version of your grammar in sync across
|
||||
different bindings. However, doing so manually is error-prone and tedious, so
|
||||
this command takes care of the burden. If you are using a version control system,
|
||||
it is recommended to commit the changes made by this command, and to tag the
|
||||
commit with the new version.
|
||||
|
||||
To print the current version without bumping it, use:
|
||||
|
||||
```bash
|
||||
tree-sitter version
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### `-p/--grammar-path <PATH>`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue