-
Notifications
You must be signed in to change notification settings - Fork 613
automate crate publishing #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Releasing | ||
|
||
Releasing, i.e. crate publishing, has been automated via GitHub Actions. | ||
|
||
We use the [`cargo release`](https://github.com/sunng87/cargo-release) | ||
subcommand to ensure correct versioning. Install via: | ||
|
||
``` | ||
$ cargo install cargo-release | ||
``` | ||
|
||
**Before releasing** ensure `CHANGELOG.md` is updated appropriately. | ||
|
||
## Process | ||
|
||
Using `cargo-release` we can author a new minor release like so: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not thinking of the new releases as "minor", so perhaps it would be useful to remind that this means There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure that makes sense to me. Maybe we should simply link to the CHANGELOG where that's described? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure, but CHANGELOG doesn't mention "minor" releases either. Technically, "minor" is the correct term with regards to semver, but in context of sqlparser using it without mentioning semver is slightly weird. Do what you think is best, I don't have a strong opinion on if or how this should be addressed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll leave this as-is for now. |
||
|
||
``` | ||
$ 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`. | ||
|
||
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`.) |
Uh oh!
There was an error while loading. Please reload this page.