-
Notifications
You must be signed in to change notification settings - Fork 44
Closed
Labels
Description
Release Checklist
Attention: the examples below use the version
x.y.zbut you should update them to use the version you're releasing.
Git Preparation
- Decide on a version number based on the current version number and the common rules defined in Semantic Versioning. E.g.
x.y.z. - Update this ticket name to reflect the new version number, following the pattern "Release
x.y.z". - Cut a branch for the new release out of the
developbranch, following the gitflow naming patternrelease/3.0.0.
Code Preparation
- Update the code to use this version number.
- Update
versionandappVersionin helmchart/sdp/Chart.yaml. - Update the constant
Versionin main.go
- Update
- Update the CHANGELOG.md file with the new version number and release notes.
- Run tests and linting, and make sure the version running in the default branch is working end-to-end. At least the minimal end-to-end manual tests is mandatory.
- 🚨 DO NOT RELEASE before holidays or weekends! Mondays and Tuesdays are preferred.
Merging the Branches
- When the team is confident the release is stable, you'll need to create two pull requests:
-
release/x.y.z -> main: 🚨 Do not squash-and-merge! This PR should be merged with a merge commit. Release3.0.0tomain#475 -
release/x.y.z -> develop: this should be merged after themainbranch is merged. 🚨 Do not squash-and-merge! This PR should be merged with a merge commit. Release3.0.0todevelop#476
-
Publishing the Release
- After the release branch is merged to
main, create a new release on GitHub with the namex.y.zand the use the same changes from the CHANGELOG.md file – v3.0.0- The release should automatically publish a new version of the docker image to Docker Hub. stellar/stellar-disbursement-platform-backend:3.0.0
- Propagate the helmchart version update to the https://github.com/stellar/helm-charts repository. – SDP Release 3.0.0 helm-charts#104 (review)