Skip to content

Commit ea643a4

Browse files
committed
add releasing doc
1 parent 9ac7979 commit ea643a4

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

RELEASING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Releasing
2+
3+
This is a checklist for releasing a new version of **titiler-stacapi**.
4+
5+
1. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the new version
6+
7+
2. Make sure the [Changelog](CHANGES.md) is up to date with latest changes and release date set
8+
9+
3. Run [`bump-my-version`](https://callowayproject.github.io/bump-my-version/) to update all titiler's module versions:
10+
11+
```
12+
bump-my-version bump minor --new-version 0.20.0
13+
```
14+
15+
4. Push your release branch, create a PR, and get approval
16+
17+
5. 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
18+
19+
```
20+
git tag vX.Y.Z
21+
```
22+
23+
6. Push your tag to Github, which will kick off the publishing workflow
24+
25+
7. Create a [new release](https://github.com/developmentseed/titiler-stacapi/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

Comments
 (0)