Skip to content

Commit 9351efb

Browse files
committed
update release instructions
1 parent 6b37c16 commit 9351efb

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ serde_json = { version = "1.0", optional = true }
3434
[dev-dependencies]
3535
simple_logger = "1.0.1"
3636
matches = "0.1"
37+
38+
[package.metadata.release]
39+
disable-publish = true

docs/releasing.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,26 @@
22

33
Releasing, i.e. crate publishing, has been automated via GitHub Actions.
44

5-
In order to author a new release, you simply tag the desired revision and push
6-
the resulting tag.
5+
We use the [`cargo release`](https://github.com/sunng87/cargo-release)
6+
subcommand to ensure correct versioning. Install via:
77

8-
**Before releasing** ensure `CHANGELOG.md` is updated appropriately as well as
9-
`Cargo.toml`.
8+
```
9+
$ cargo install cargo-release
10+
```
11+
12+
**Before releasing** ensure `CHANGELOG.md` is updated appropriately.
1013

1114
## Process
1215

13-
Please ensure you follow the correct format when creating new tags. For
14-
instance:
16+
Using `cargo-release` we can author a new minor release like so:
1517

1618
```
17-
git tag -a '0.6.0' -m '(cargo-release) sqlparser version 0.6.0'
19+
$ cargo release minor --skip-publish
1820
```
1921

22+
**Ensure publishing is skipped** since pushing the resulting tag upstream will
23+
handle crate publishing automatically.
24+
2025
This will create a new tag, `0.6.0` with the message,
2126
`(cargo-release) sqlparser version 0.6.0`.
2227

0 commit comments

Comments
 (0)