Skip to content

Commit a591648

Browse files
committed
update changelog and add release info in Contribution
1 parent a6e062f commit a591648

File tree

3 files changed

+24
-3
lines changed

3 files changed

+24
-3
lines changed

CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Notes
22

3-
## Unreleased
3+
## 0.20.0 (2025-01-07)
44

55
### titiler.core
66

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,23 @@ Actions deploys automatically for new commits.):
6262
```bash
6363
mkdocs gh-deploy -f docs/mkdocs.yml
6464
```
65+
66+
### Release
67+
68+
This is a checklist for releasing a new version of **titiler**.
69+
70+
1. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version
71+
72+
2. Make sure the [Changelog](CHANGES.md) is up to date with latest changes and release date set
73+
74+
3. Update `version: {chart_version}` (e.g: `version: 1.1.6 -> version: 1.1.7`) in `deployment/k8s/charts/Chart.yaml`
75+
76+
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`
77+
78+
5. Push your release branch, create a PR, and get approval
79+
80+
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
81+
82+
7. Push your tag to Github, which will kick off the publishing workflow
83+
84+
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

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,9 @@ serialize = [
153153
search = "{current_version}"
154154
replace = "{new_version}"
155155
regex = false
156-
tag = true
157-
commit = true
156+
tag = false
157+
commit = false
158+
allow_dirty = true
158159
tag_name = "{new_version}"
159160

160161
###############################################################################

0 commit comments

Comments
 (0)