Skip to content

Commit

Permalink
update changelog and add release info in Contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentsarago committed Jan 7, 2025
1 parent a6e062f commit a591648
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Notes

## Unreleased
## 0.20.0 (2025-01-07)

### titiler.core

Expand Down
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,23 @@ Actions deploys automatically for new commits.):
```bash
mkdocs gh-deploy -f docs/mkdocs.yml
```

### Release

This is a checklist for releasing a new version of **titiler**.

1. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version

2. Make sure the [Changelog](CHANGES.md) is up to date with latest changes and release date set

3. Update `version: {chart_version}` (e.g: `version: 1.1.6 -> version: 1.1.7`) in `deployment/k8s/charts/Chart.yaml`

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`

5. Push your release branch, create a PR, and get approval

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

7. Push your tag to Github, which will kick off the publishing workflow

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
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,9 @@ serialize = [
search = "{current_version}"
replace = "{new_version}"
regex = false
tag = true
commit = true
tag = false
commit = false
allow_dirty = true
tag_name = "{new_version}"

###############################################################################
Expand Down

0 comments on commit a591648

Please sign in to comment.