From 7d37aa5c997474415b540887f5169f3005c21969 Mon Sep 17 00:00:00 2001 From: c9s Date: Thu, 30 Dec 2021 00:29:21 +0800 Subject: [PATCH] doc/development: update release process for changelog --- doc/development/release-process.md | 13 ++++++++----- utils/changelog.sh | 4 ++-- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/development/release-process.md b/doc/development/release-process.md index c3f947e93..004277dbd 100644 --- a/doc/development/release-process.md +++ b/doc/development/release-process.md @@ -12,6 +12,14 @@ If your next version is `v1.20.2`, then you should put the release note in the f doc/release/v1.20.2.md ``` +Run changelog script to generate a changelog template: + +```sh +bash utils/changelog.sh +``` + +Edit your changelog. + ## 2. Make the release Run the following command to create the release: @@ -27,10 +35,5 @@ The above command wilL: - Run git tag to create the tag. - Run git push to push the created tag. -Run changelog script to generate a changelog template: - -```sh -bash utils/changelog.sh -``` You can go to to modify the changelog diff --git a/utils/changelog.sh b/utils/changelog.sh index 33a5c1449..727c08225 100644 --- a/utils/changelog.sh +++ b/utils/changelog.sh @@ -22,8 +22,8 @@ LATEST_TAG=${TAGS[0]} PREVIOUS_TAG=${TAGS[1]} # If you want to specify your own two tags to compare, uncomment and enter them below -# LATEST_TAG=v0.23.1 -# PREVIOUS_TAG=v0.22.0 +PREVIOUS_TAG=$LATEST_TAG +LATEST_TAG=main # Get a log of commits that occured between two tags # We only get the commit hash so we don't have to deal with a bunch of ugly parsing