-
Notifications
You must be signed in to change notification settings - Fork 79
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
ci: create a release-plz action #884
Conversation
Hey @jdrouet, thanks for this. Is this a replacement for just publishing to crates.io? Could we also make it publish a version tag? |
It should generate version tags, readmes and publish to crates.io. The complete process. |
Hi @jdrouet, this looks promising. Are you willing to followup with the remaining steps and demonstrate how to create the next VRL release? |
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.
Nice, I agree this looks promising. A couple of questions:
- Would this let us delete some of the release scripts currently in
scripts/
? - It seems like this publishes on every push to
main
. Do we want that? - Agreed with @pront that we should document this. I'd suggest doing so in the README
Sorry for the late reply.
I think, we should let
No, it's more magic than that. It will run on every commit on the main branch to generate a new release PR but it will release only when merging that release PR. (Here is an example or here a simpler one) In that release PR, it will update the changelog, update the version of the package according to the semantic versioning stuff. You can modify the PR if you don't agree with the picked version or if you wanna change the changelog.
Could you clarify what you would expect in the readme?
But first, we could also try using the release-plz binary locally to see if it works properly with VRL (never done that locally, I always go rogue on the CI for my project, but I understand we cannot do that here). To conclude this, if we merge this PR, it will not release VRL. It will create a PR (or update the existing one) each time we merge something in the main branch. And IF and ONLY IF, we merge that PR, it will release the package (creating the release in github and publishing it in crates.io). |
Signed-off-by: Jérémie Drouet <[email protected]>
Signed-off-by: Jérémie Drouet <[email protected]>
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.
Seems worth trying out to me 👍 I'll let @pront review too.
After the direct discussion we had, I think we can close this for now |
This PR creates a configuration for release-plz.
To make this work, we need to follow the first 2 steps from this doc. This will add a secret token that will allow this new action to publish the new release to crates.io.
Fixes #880