2021-12-05 04:05:11 +00:00
|
|
|
# Release Process
|
|
|
|
|
|
2021-12-06 15:42:48 +00:00
|
|
|
## 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
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-29 16:29:21 +00:00
|
|
|
Run changelog script to generate a changelog template:
|
|
|
|
|
|
|
|
|
|
```sh
|
2022-05-03 04:44:03 +00:00
|
|
|
bash utils/changelog.sh > doc/release/v1.20.2.md
|
2021-12-29 16:29:21 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Edit your changelog.
|
|
|
|
|
|
2021-12-06 15:42:48 +00:00
|
|
|
## 2. Make the release
|
|
|
|
|
|
|
|
|
|
Run the following command to create the release:
|
|
|
|
|
|
2021-12-05 04:05:11 +00:00
|
|
|
```sh
|
2021-12-06 15:42:48 +00:00
|
|
|
make version VERSION=v1.20.2
|
2021-12-05 04:05:11 +00:00
|
|
|
```
|
|
|
|
|
|
2021-12-06 15:42:48 +00:00
|
|
|
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.
|
|
|
|
|
|
2021-12-29 16:16:21 +00:00
|
|
|
|
2021-12-06 15:42:48 +00:00
|
|
|
You can go to <https://github.com/c9s/bbgo/releases/v1.20.2> to modify the changelog
|
