-
Notifications
You must be signed in to change notification settings - Fork 36
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
Release preparation #105
Release preparation #105
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM at a high level.
uses: MarcoIeni/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this leak these secrets?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
version = "0.1.0" | ||
edition = "2021" | ||
license-file = "LICENSE" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way to include multiple licenses? Say of third-party code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cargo only supports one license file: rust-lang/cargo#5933 but it does support multiple license expressions like: license = "MIT OR Apache-2.0"
. I'll try to combine licenses in one license file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want the project to be MIT licensed; only some borrowed parts to be differently licensed. We can leave the license file as-is till we find out if there is a precedent on how what we want is accomplished.
@@ -1,7 +1,11 @@ | |||
[package] | |||
name = "regorus" | |||
description = "A fast, lightweight Rego (OPA policy language) interpreter" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does crates.io allow marking a release as alpha/beta?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, we can add -alpha
suffix, I'll change it to 0.0.1-alpha
Merging this in to make progress. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Updated
Cargo.toml
with the necessary fields, created release-plz workflow file, and ranrelease-plz update
to generateCHANGELOG
file.Release-plz GitHub Action quickstart guide (that also contains generating a token for crates.io) must be followed to complete the release automation: https://release-plz.ieni.dev/docs/github/quickstart.
Afterward, release-plz will create a rolling PR (example: release-plz/release-plz#1171) that will be updated with every change. Whenever we want to make a new release we will simply merge that PR and that will trigger GitHub workflow and run
release-plz release
which is going to detect the new version and then going to publish a release tag on GitHub and a new version on crates.io.For the first release, we might need to run
release-plz release
manually.