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

ci: unified crates.io release workflow using release-plz #78

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

antonbaliasnikov
Copy link
Collaborator

Overview

Use a common unified CI for Rust release using release-plz.

Unified workflow source code

Details

  • The workflow is similar to the release-please workflow as it creates a release PR with expected changes, monitors next semver, updates changelogs etc. but it's more specialized for Rust packages because it supports crates.io publishing out of the box, additional breaking API checks using cargo-semver-checks, easier to configure and support (for example, only one workflow file instead of two).
  • The behavior is configurable through release-plz.toml file in the workspace root. Comments added to each line to explain what each setting does.

Current restrictions

As release-plz does not provide the same output context as release-please, notifications for successful releases are not sent yet in the same format. It would require refactoring of the format-release-please-for-slack-action or simplier, just use GitHub release notifications in Slack that will not require any set up.

Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess RELEASE.md also needs to be updated.

release-plz.toml Outdated Show resolved Hide resolved
@antonbaliasnikov antonbaliasnikov force-pushed the aba-unified-release-pipeline branch from 0a462ad to 1c24b66 Compare December 5, 2024 12:40
@antonbaliasnikov antonbaliasnikov marked this pull request as ready for review December 5, 2024 12:40
@antonbaliasnikov
Copy link
Collaborator Author

@popzxc , I also checked that the bot user has the correct permissions for this repository, so we can proceed with the merge and the final stage of testing.

popzxc
popzxc previously approved these changes Dec 5, 2024
@antonbaliasnikov
Copy link
Collaborator Author

Some more fixes are in progress.

@antonbaliasnikov antonbaliasnikov force-pushed the aba-unified-release-pipeline branch from 580bbbe to 5d9a2f3 Compare December 5, 2024 15:53
@popzxc popzxc merged commit 746d975 into main Dec 6, 2024
6 checks passed
@popzxc popzxc deleted the aba-unified-release-pipeline branch December 6, 2024 09:24
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.

2 participants