Skip to content

Commit b7461f5

Browse files
authored
chore(doc): add documentation of release process (#687)
relates to STACKITTPR-200
1 parent 5dcca3b commit b7461f5

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,10 @@ If you encounter any issues or have suggestions for improvements, please open an
189189

190190
Your contribution is welcome! For more details on how to contribute, refer to our [contribution guide](./CONTRIBUTION.md).
191191

192+
## Release creation
193+
194+
See the [release documentation](./RELEASE.md) for further information.
195+
192196
## License
193197

194198
Apache 2.0

RELEASE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Release
2+
3+
## Release cycle
4+
5+
A release should be created at least every 2 weeks.
6+
7+
## Release creation
8+
9+
> [!IMPORTANT]
10+
> Consider informing / syncing with the team before creating a new release.
11+
12+
1. Check out latest main branch on your machine
13+
2. Create git tag: `git tag vX.X.X`
14+
3. Push the git tag: `git push origin --tags`
15+
4. The [release pipeline](https://github.com/stackitcloud/stackit-cli/actions/workflows/release.yaml) will build the release and publish it on GitHub
16+
5. Ensure the release was created properly using the [releases page](https://github.com/stackitcloud/stackit-cli/releases)
17+

0 commit comments

Comments
 (0)