|
2 | 2 |
|
3 | 3 | This is a checklist for releasing a new version of **titiler**. |
4 | 4 |
|
5 | | -1. Determine the next version |
| 5 | +1. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version |
6 | 6 |
|
7 | | - We currently do not have published versioning guidelines. We usually use `minor` version update when pushing breaking changes and `patch` for every other updates |
| 7 | +2. Make sure the [Changelog](CHANGES.md) is up to date with latest changes and release date set |
8 | 8 |
|
9 | | -2. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version |
10 | | -3. Search and replace all instances of the current version number with the new version |
| 9 | +3. Update `version: {chart_version}` (e.g: `version: 1.1.6 -> version: 1.1.7`) in `deployment/k8s/charts/Chart.yaml` |
11 | 10 |
|
12 | | - We recommend to use [`bump-my-version`](https://github.com/callowayproject/bump-my-version) CLI |
13 | | - ``` |
14 | | - bump-my-version bump --new-version 3.1.0 |
15 | | - ``` |
| 11 | +4. Run [`bump-my-version`](https://callowayproject.github.io/bump-my-version/) to update all titiler's module versions: `bump-my-version bump minor --new-version 0.20.0` |
16 | 12 |
|
17 | | -4. Manually increase the helm chart `version` in `/deployment/k8s/charts/Chart.yaml (not matching titiler's version) |
18 | | -5. Update [CHANGES.md](./CHANGES.md) for the new version |
19 | | -6. Push your release branch, create a PR, and get approval |
20 | | -7. Once the PR is merged, create a new (annotated, signed) tag on the appropriate commit |
| 13 | +5. Push your release branch, create a PR, and get approval |
21 | 14 |
|
22 | | - Name the tag `X.Y.Z`, and include `vX.Y.Z` as its annotation message |
| 15 | +6. Once the PR is merged, create a new (annotated, signed) tag on the appropriate commit. Name the tag `X.Y.Z`, and include `vX.Y.Z` as its annotation message |
23 | 16 |
|
24 | | -8. Push your tag to Github, which will kick off the publishing workflow |
25 | | -9. Create a [new release](https://github.com/developmentseed/titiler/releases/new) targeting the new tag, and use the "Generate release notes" feature to populate the description. |
| 17 | +7. Push your tag to Github, which will kick off the publishing workflow |
26 | 18 |
|
27 | | - Publish the release and mark it as the latest. |
| 19 | +8. Create a [new release](https://github.com/developmentseed/titiler/releases/new) targeting the new tag, and use the "Generate release notes" feature to populate the description. Publish the release and mark it as the latest |
0 commit comments