lychiyu/bbgo_origin
1
0
Fork 0
mirror of https://github.com/c9s/bbgo.git synced 2024-09-20 08:11:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc/development: update release process for changelog

Browse Source
This commit is contained in:
c9s 2021-12-30 00:29:21 +08:00
parent 1e16ece5b9
commit 7d37aa5c99
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/development/release-process.md
View File

@ -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 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 ## 2. Make the release
Run the following command to create 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 tag to create the tag.
- Run git push to push the created 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 <https://github.com/c9s/bbgo/releases/v1.20.2> to modify the changelog You can go to <https://github.com/c9s/bbgo/releases/v1.20.2> to modify the changelog

4
utils/changelog.sh
View File

@ -22,8 +22,8 @@ LATEST_TAG=${TAGS[0]}
PREVIOUS_TAG=${TAGS[1]} PREVIOUS_TAG=${TAGS[1]}
# If you want to specify your own two tags to compare, uncomment and enter them below # If you want to specify your own two tags to compare, uncomment and enter them below
# LATEST_TAG=v0.23.1 PREVIOUS_TAG=$LATEST_TAG
# PREVIOUS_TAG=v0.22.0 LATEST_TAG=main
# Get a log of commits that occured between two tags # 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 # We only get the commit hash so we don't have to deal with a bunch of ugly parsing