diff --git a/Cargo.toml b/Cargo.toml index 95c2ec9b..81a3c64e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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 diff --git a/docs/releasing.md b/docs/releasing.md index 2cc6535d..66b41901 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -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`.