lychiyu/bbgo_origin
1
0
Fork 0
mirror of https://github.com/c9s/bbgo.git synced 2024-11-21 22:43:52 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update the release process doc

Browse Source
This commit is contained in:
c9s 2021-12-06 23:42:48 +08:00
parent 7dd88a86f0
commit ceb4d1353e
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,30 @@
# Release Process
```sh
make version VERSION=v1.18.2
## 1. Prepare the release note
You need to prepare the release note for your next release version.
The release notes are placed in the `doc/release` directory.
If your next version is `v1.20.2`, then you should put the release note in the following file:
```
doc/release/v1.20.2.md
```
go to <https://github.com/c9s/bbgo/releases/v1.18.2> to modify the changelog
## 2. Make the release
Run the following command to create the release:
```sh
make version VERSION=v1.20.2
```
The above command wilL:
- Update and compile the migration scripts into go files.
- Bump the version name in the go code.
- Run git tag to create the tag.
- Run git push to push the created tag.
You can go to <https://github.com/c9s/bbgo/releases/v1.20.2> to modify the changelog