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

chore(release): v0.4.0 #7

Merged
merged 3 commits into from
Dec 16, 2024
Merged

chore(release): v0.4.0 #7

merged 3 commits into from
Dec 16, 2024

Conversation

jssblck
Copy link
Member

@jssblck jssblck commented Dec 16, 2024

Overview

Prepares to release the version specified in the title.
Once all checks pass, the release should be good to go.

Release steps

# Choose a version. It should be valid semver.
# Also, choose a branch name. A good default is `prep/$VERSION`.
VERSION=<VERSION>
BRANCH="prep/$VERSION"

# Make a branch for release prep and check it out.
git checkout -b $BRANCH

# Have cargo-release create the release.
# This does several things:
# - Validates that the git index is clean
# - Updates version numbers in the crates
# - Generates the changelog using `git-cliff`
# - Creates a commit with the changes
# - Pushes the branch to the remote
cargo release --no-publish --no-tag --allow-branch=$BRANCH $VERSION

# NOTE: We are here; this PR was created by this step.
#       After the PR is merged, perform the final step below.
#
# Open a PR; once tests pass and reviewers approve, merge to main and come back here for the final step.
# The PR title should be "chore(release): $VERSION" or something that similarly avoids generating a changelog entry;
# see the `cliff.toml` file for more details.
gh pr create --base main --body-file .github/release_template.md --title "chore(release): $VERSION"

# Finally, run `cargo release` on the main branch.
# This doesn't create new commits; it just tags the commit and pushes the tag.
git checkout main
git pull
cargo release

@jssblck jssblck requested a review from a team as a code owner December 16, 2024 20:17
@jssblck jssblck requested a review from nficca December 16, 2024 20:17
@jssblck jssblck changed the title chore(release): chore(release): v0.4.0 Dec 16, 2024
@jssblck jssblck enabled auto-merge (squash) December 16, 2024 20:18
@jssblck jssblck disabled auto-merge December 16, 2024 20:22
@jssblck jssblck merged commit d0e1dd5 into main Dec 16, 2024
20 checks passed
@jssblck jssblck deleted the prep/v0.4.0 branch December 16, 2024 20:22
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.

1 participant