mirror of
https://github.com/apache/datafusion-sqlparser-rs.git
synced 2025-07-07 17:04:59 +00:00
document initial release process
This commit is contained in:
parent
bc9bfaeb84
commit
1a70c6e1fe
1 changed files with 32 additions and 0 deletions
32
docs/releasing.md
Normal file
32
docs/releasing.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# Releasing
|
||||
|
||||
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.
|
||||
|
||||
**Before releasing** ensure `CHANGELOG.md` is updated appropriately as well as
|
||||
`Cargo.toml`.
|
||||
|
||||
## Process
|
||||
|
||||
Please ensure you follow the correct format when creating new tags. For
|
||||
instance:
|
||||
|
||||
```
|
||||
git tag -a '0.6.0' -m '(cargo-release) sqlparser version 0.6.0'
|
||||
```
|
||||
|
||||
This will create a new tag, `0.6.0` which the message,
|
||||
`(cargo-release) sqlparser version 0.6.0`.
|
||||
|
||||
Once the tag is created, pushing the tag upstream will trigger a publishing
|
||||
process to crates.io. Now to push our example tag:
|
||||
|
||||
```
|
||||
git push origin 0.6.0
|
||||
```
|
||||
|
||||
(Note that this process is fully automated; credentials
|
||||
for authoring in this way are securely stored in the repo secrets as
|
||||
`CRATE_TOKEN`.)
|
Loading…
Add table
Add a link
Reference in a new issue