Skip to content

Commit 1a70c6e

Browse files
committed
document initial release process
1 parent bc9bfae commit 1a70c6e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/releasing.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Releasing
2+
3+
Releasing, i.e. crate publishing, has been automated via GitHub Actions.
4+
5+
In order to author a new release, you simply tag the desired revision and push
6+
the resulting tag.
7+
8+
**Before releasing** ensure `CHANGELOG.md` is updated appropriately as well as
9+
`Cargo.toml`.
10+
11+
## Process
12+
13+
Please ensure you follow the correct format when creating new tags. For
14+
instance:
15+
16+
```
17+
git tag -a '0.6.0' -m '(cargo-release) sqlparser version 0.6.0'
18+
```
19+
20+
This will create a new tag, `0.6.0` which the message,
21+
`(cargo-release) sqlparser version 0.6.0`.
22+
23+
Once the tag is created, pushing the tag upstream will trigger a publishing
24+
process to crates.io. Now to push our example tag:
25+
26+
```
27+
git push origin 0.6.0
28+
```
29+
30+
(Note that this process is fully automated; credentials
31+
for authoring in this way are securely stored in the repo secrets as
32+
`CRATE_TOKEN`.)

0 commit comments

Comments
 (0)