Skip to content

Commit 506326d

Browse files
committed
Document release process
1 parent 461f1f8 commit 506326d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,18 @@ Commands:
4545
## Documentation
4646

4747
Please visit [https://cloudscale-ch.github.io/cloudscale-cli](https://cloudscale-ch.github.io/cloudscale-cli).
48+
49+
## Releases
50+
51+
To create a new release, follow these steps:
52+
53+
1. Create a branch named `release/<major>.<minor>.<patch>`.
54+
2. Create a PR of the branch and get it approved.
55+
3. Merge the change.
56+
4. Tag the release commit and push the tags.
57+
58+
The branch should include the following:
59+
60+
- A single commit that updates the release.
61+
- A version update in `cloudscale_cli/version.py`.
62+
- An updated changelog in `CHANGELOG.md`.

0 commit comments

Comments
 (0)