From ee288a0a352a16c7f191baa2fe9d9638a98059c4 Mon Sep 17 00:00:00 2001 From: Jessica Black Date: Fri, 13 Dec 2024 16:48:00 -0800 Subject: [PATCH] doc(release): update suggested release PR name --- .github/release_template.md | 8 ++++++-- docs/dev/README.md | 5 +++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/release_template.md b/.github/release_template.md index 115663e..a58c33f 100644 --- a/.github/release_template.md +++ b/.github/release_template.md @@ -23,9 +23,13 @@ git checkout -b $BRANCH # - Pushes the branch to the remote cargo release --no-publish --no-tag --allow-branch=$BRANCH $VERSION -# Open a PR; once tests pass and reviewers approve, merge to main and come back here for the final step. # NOTE: We are here; this PR was created by this step. -gh pr create --base main --body-file .github/release_template.md --title "Prepare to release $VERSION" +# 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. diff --git a/docs/dev/README.md b/docs/dev/README.md index d2d3b2f..85aa2ef 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -85,8 +85,9 @@ git checkout -b $BRANCH cargo release --no-publish --no-tag --allow-branch=$BRANCH $VERSION # Open a PR; once tests pass and reviewers approve, merge to main and come back here for the final step. -# NOTE: We are here; this PR was created by this step. -gh pr create --base main --body-file .github/release_template.md --title "Prepare to release $VERSION" +# 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.