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

Update releasing.md docs

Browse source
This commit is contained in:
Nickolay Ponomarev 2020-09-27 21:54:01 +03:00
parent fcf1eb1b67
commit cc4f51fe10
2 changed files with 43 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Cargo.toml
View file

@ -36,6 +36,7 @@ simple_logger = "1.6"
matches = "0.1" matches = "0.1"
[package.metadata.release] [package.metadata.release]
# We want to ensure we don't publish via `cargo release` since Actions # Instruct `cargo release` to not run `cargo publish` locally:
# handles this for us. # https://github.com/sunng87/cargo-release/blob/master/docs/reference.md#config-fields
# See docs/releasing.md for details.
disable-publish = true disable-publish = true

59
docs/releasing.md
View file

@ -1,6 +1,9 @@
# Releasing # Releasing
Releasing, i.e. crate publishing, has been automated via GitHub Actions. ## Prerequisites
Publishing to crates.io has been automated via GitHub Actions, so you will only
need push access to the [ballista-compute GitHub repository](https://github.com/ballista-compute/sqlparser-rs)
in order to publish a release.
We use the [`cargo release`](https://github.com/sunng87/cargo-release) We use the [`cargo release`](https://github.com/sunng87/cargo-release)
subcommand to ensure correct versioning. Install via: subcommand to ensure correct versioning. Install via:
@ -9,29 +12,47 @@ subcommand to ensure correct versioning. Install via:
$ cargo install cargo-release $ cargo install cargo-release
``` ```
**Before releasing** ensure `CHANGELOG.md` is updated appropriately.
## Process ## Process
Using `cargo-release` we can author a new minor release like so: 1. **Before releasing** ensure `CHANGELOG.md` is updated appropriately and that
you have a clean checkout of the `main` branch of the sqlparser repository:
```
$ git fetch && git status
On branch main
Your branch is up to date with 'upstream/main'.
``` nothing to commit, working tree clean
$ cargo release minor --skip-publish ```
``` * If you have the time, check that the examples in the README are up to date.
**Ensure publishing is skipped** since pushing the resulting tag upstream will 2. Using `cargo-release` we can publish a new release like so:
handle crate publishing automatically.
This will create a new tag, `0.6.0` with the message, ```
`(cargo-release) sqlparser version 0.6.0`. $ cargo release minor --push-remote upstream
```
Once the tag is created, pushing the tag upstream will trigger a publishing You can add `--dry-run` to see what the command is going to do,
process to crates.io. Now to push our example tag: or `--skip-push` to stop before actually publishing the release.
``` `cargo release` will then:
git push origin 0.6.0
``` * Bump the minor part of the version in `Cargo.toml` (e.g. `0.7.1-alpha.0`
-> `0.8.0`. You can use `patch` instead of `minor`, as appropriate).
* Create a new tag (e.g. `v0.8.0`) locally
* Push the new tag to the specified remote (`upstream` in the above
example), which will trigger a publishing process to crates.io as part of
the [corresponding GitHub Action](https://github.com/ballista-compute/sqlparser-rs/blob/main/.github/workflows/rust.yml).
Note that credentials for authoring in this way are securely stored in
the (GitHub) repo secrets as `CRATE_TOKEN`.
* Bump the crate version again (to something like `0.8.1-alpha.0`) to
indicate the start of new development cycle.
3. Push the updates to the `main` branch upstream:
```
$ git push upstream
```
4. Check that the new version of the crate is available on crates.io:
https://crates.io/crates/sqlparser
(Note that this process is fully automated; credentials
for authoring in this way are securely stored in the repo secrets as
`CRATE_TOKEN`.)