From 3d6d2e0141dae043c50b49013d5d33f9667b016c Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Sun, 31 Jul 2022 05:24:36 -0400 Subject: [PATCH] Fixup release-pr body formatting (#345) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add CHANGELOG Signed-off-by: Kingdon Barrett * fixup link see DEVELOPMENT.md for more details 👍 Signed-off-by: Kingdon Barrett * fixup release pr body description Signed-off-by: Kingdon Barrett --- .github/workflows/build-vsix.yml | 18 +++++++----------- CHANGELOG.md | 8 ++++++++ 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build-vsix.yml b/.github/workflows/build-vsix.yml index d49cb6de..d9aba85c 100644 --- a/.github/workflows/build-vsix.yml +++ b/.github/workflows/build-vsix.yml @@ -187,20 +187,16 @@ jobs: destination_branch: "main" pr_title: "Release ${{ env.GIT_TAG }}" pr_body: |- - A release has been tagged and published, `${{ env.GIT_TAG }}`! 🎉 - Ensure the CHANGELOG is updated by pushing it to this branch, (or skip this step and save it for MINOR releases.) - A CHANGELOG has been generated here, - [`${{ env.GIT_TAG }}`](https://github.com/weaveworks/vscode-gitops-tools/releases/tag/${{ env.GIT_TAG }}) - you can copy directly from it, or edit the messages for uniformity and clarity. + A release has been tagged and published, ${{ env.GIT_TAG }}! 🎉 - When you are done, merge this PR with the tag (**Do Not Squash** or rebase! - Push new commits and **merge only**) in order to complete the release. + Please ensure that `CHANGELOG.md` remains current by pushing any needed updates as a commit to this branch. + A CHANGELOG has been generated for this release here, \[v`${{ env.GIT_TAG }}`\](https://github.com/weaveworks/vscode-gitops-tools/releases/tag/${{ env.GIT_TAG }}) – you can copy directly from it, or edit for uniformity and clarity. - Feature branches should normally be squashed, but this one must be merged to include the tag in the main branch's history. + When you are done, merge this PR with the tag intact (**Do Not Squash** or rebase! Push new commits and **merge only**) to complete the release. - The tag must be in the default branch, so the release machine can know what patch version - to use next, and for auto CHANGELOG generation to know when to stop reading in changes, as - the CHANGELOG generator will scan gathering history, all the way up until the previous tag. + Feature branches should still be squashed, but `release-pr` must always be merged. + + See the \[DEVELOPMENT.md\](/DEVELOPMENT.md#releasing) for more information about this Pull Request. pr_reviewer: ${{ github.actor }} pr_draft: false github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 0083ff24..2f0b6de9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ See [releases](https://github.com/weaveworks/vscode-gitops-tools/releases) for s The current release notes are always published on the Releases page, by automation. This `CHANGELOG` is manually curated by a release engineer from those notes for house-keeping. +# v0.20.5 - [2022-07-31] + +* Fixup release-pr body formatting (#344) + +# v0.20.4 - [2022-07-31] + +* Make release process slightly better documented (#342) + # v0.20.3 - [2022-07-29] * rename Pull Git Repository (#340)