Skip to content
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

feat: automated releases w/ release-plz #244

Closed
wants to merge 1 commit into from

Conversation

bennyhodl
Copy link
Contributor

It would be nice to have automated releases on merged PRs. I have used release-plz in another project and it is great.

  • uses github actions
  • generates changelogs
  • creates tags & releases
  • follow semver to automatically update version
  • publishes to crates

All that is needed is to add the CARGO_REGISTRY_TOKEN and RELEASE_PLZ_TOKEN (which is a GH token) added to the repository secrets. @Tibo-lg can add them or if you would like me to manage releases, you can add me as a repo actions owner and a package owner on crates.

Useful links:
release-plz docs
release-plz github actions docs
release-plz configuration

@Tibo-lg
Copy link
Contributor

Tibo-lg commented Nov 5, 2024

Thanks but I don't especially like this. While convenient I would need to trust what it is doing to the code and the policy is to minimize dependencies in general to avoid security issues.

@Tibo-lg Tibo-lg closed this Nov 5, 2024
@bennyhodl
Copy link
Contributor Author

release-plz under the hood uses std::process::Command for git history and publishing to cargo. Even the rust-foundation uses it

For the past few months I have had to ask for releases and have had to use patches exclusively for ddk. This is not sustainable for downstream projects. I would rather have a conversation about it than immediately close.

I think this is a net benefit for the project as you do not have to manually do releases, tags, change logs, and publish given your limited time.

@bonomat
Copy link
Collaborator

bonomat commented Nov 5, 2024

Any reason why you (@bennyhodl ) are not depending on a specific git commit until there is a release?
This worked great for us at 10101 in the past.

@bennyhodl
Copy link
Contributor Author

Any reason why you (@bennyhodl ) are not depending on a specific git commit until there is a release?

This worked great for us at 10101 in the past.

Because ddk is a library I cannot publish to crates.io with a fit link

@Tibo-lg
Copy link
Contributor

Tibo-lg commented Nov 6, 2024

In general I try to follow the processes of other crates in the rust-bitcoin ecosystem. AFAICT none of them are using this, and giving the ability for a third party tool to publish on creates.io is not something that feels secure to me. If you want to help with releases, feel free to make release PRs so that I can check them and merge them. Doing the release on crates.io doesn't take much time, it's more the preparation that does.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants