mirror of
https://github.com/apache/datafusion-sqlparser-rs.git
synced 2025-07-07 17:04:59 +00:00
update release instructions
This commit is contained in:
parent
6b37c1642f
commit
9351efb437
2 changed files with 15 additions and 7 deletions
|
@ -34,3 +34,6 @@ serde_json = { version = "1.0", optional = true }
|
|||
[dev-dependencies]
|
||||
simple_logger = "1.0.1"
|
||||
matches = "0.1"
|
||||
|
||||
[package.metadata.release]
|
||||
disable-publish = true
|
||||
|
|
|
@ -2,21 +2,26 @@
|
|||
|
||||
Releasing, i.e. crate publishing, has been automated via GitHub Actions.
|
||||
|
||||
In order to author a new release, you simply tag the desired revision and push
|
||||
the resulting tag.
|
||||
We use the [`cargo release`](https://github.com/sunng87/cargo-release)
|
||||
subcommand to ensure correct versioning. Install via:
|
||||
|
||||
**Before releasing** ensure `CHANGELOG.md` is updated appropriately as well as
|
||||
`Cargo.toml`.
|
||||
```
|
||||
$ cargo install cargo-release
|
||||
```
|
||||
|
||||
**Before releasing** ensure `CHANGELOG.md` is updated appropriately.
|
||||
|
||||
## Process
|
||||
|
||||
Please ensure you follow the correct format when creating new tags. For
|
||||
instance:
|
||||
Using `cargo-release` we can author a new minor release like so:
|
||||
|
||||
```
|
||||
git tag -a '0.6.0' -m '(cargo-release) sqlparser version 0.6.0'
|
||||
$ cargo release minor --skip-publish
|
||||
```
|
||||
|
||||
**Ensure publishing is skipped** since pushing the resulting tag upstream will
|
||||
handle crate publishing automatically.
|
||||
|
||||
This will create a new tag, `0.6.0` with the message,
|
||||
`(cargo-release) sqlparser version 0.6.0`.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue