mirrors/datafusion-sqlparse
1
0
Fork 0
mirror of https://github.com/apache/datafusion-sqlparser-rs.git synced 2025-08-04 06:18:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update release instructions

Browse source
This commit is contained in:
Max Countryman 2020-08-01 07:30:41 -07:00
parent 6b37c1642f
commit 9351efb437
2 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Cargo.toml
View file

@ -34,3 +34,6 @@ serde_json = { version = "1.0", optional = true }
[dev-dependencies] [dev-dependencies]
simple_logger = "1.0.1" simple_logger = "1.0.1"
matches = "0.1" matches = "0.1"
[package.metadata.release]
disable-publish = true

19
docs/releasing.md
View file

@ -2,21 +2,26 @@
Releasing, i.e. crate publishing, has been automated via GitHub Actions. 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 We use the [`cargo release`](https://github.com/sunng87/cargo-release)
the resulting tag. 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 ## Process
Please ensure you follow the correct format when creating new tags. For Using `cargo-release` we can author a new minor release like so:
instance:
``` ```
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, This will create a new tag, `0.6.0` with the message,
`(cargo-release) sqlparser version 0.6.0`. `(cargo-release) sqlparser version 0.6.0`.