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

Add release-plz ci workflow #93

Merged
merged 8 commits into from
Jan 1, 2024
Merged

Add release-plz ci workflow #93

merged 8 commits into from
Jan 1, 2024

Conversation

c12i
Copy link
Owner

@c12i c12i commented Dec 7, 2023

This MR overhauls how the release process is handled.

We now leverage release-plz to handle crate releases and CHANGELOG generation.

Proposed workflow.

  1. Run release-pr locally: this involves running release-plz release-pr locally with a GITHUB_TOKEN (This action should ideally only be limited to repo maintainers). This should open a release PR with semver version bumps based on conventional commits prior to this PR via git cliff (handled automatically) by release-plz
  2. Push release tag: Same as what was done before, run git tag v* locally and push the tag.
  3. Draft Release: Draft a release for the pushed tag. The content of this release can be derived from the generated CHANGELOG from release-plz.
  4. Publish release: Publish the draft release to trigger the release ci workflow that will now publish the crate to crates.io and run other workflows i.e update gh pages docs.

Caveats

  • release-plz assumes the repository follows conventional commits in order to determine whether a patch, minor or major bump is required, as well as to generate changelog content. Conventional commits are currently not enforced for this repo, we will therefore need to adopt them to allow for seamless releases. The CONTRIBUTING.md guide has been updated with this info.
  • What does this mean for the upcoming release. 1.2.0? We will skip step 1 (Initialize release-pr locally) of the proposed workflow since there are no historical conventional commits for release-plz to generate a CHANGELOG and bump version from.

@c12i c12i marked this pull request as ready for review December 7, 2023 11:30
Copy link
Collaborator

@itsyaasir itsyaasir left a comment

Choose a reason for hiding this comment

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

Let's get this merged in to follow the commit conventions

@c12i c12i merged commit e08ed56 into master Jan 1, 2024
11 checks passed
@c12i c12i deleted the add-release-plz-ci-wf branch January 1, 2024 16:01
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