diff --git a/README.md b/README.md index fd3d5d770..2b48581ad 100644 --- a/README.md +++ b/README.md @@ -189,6 +189,10 @@ If you encounter any issues or have suggestions for improvements, please open an Your contribution is welcome! For more details on how to contribute, refer to our [contribution guide](./CONTRIBUTION.md). +## Release creation + +See the [release documentation](./RELEASE.md) for further information. + ## License Apache 2.0 diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..7b701cf6b --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,17 @@ +# Release + +## Release cycle + +A release should be created at least every 2 weeks. + +## Release creation + +> [!IMPORTANT] +> Consider informing / syncing with the team before creating a new release. + +1. Check out latest main branch on your machine +2. Create git tag: `git tag vX.X.X` +3. Push the git tag: `git push origin --tags` +4. The [release pipeline](https://github.com/stackitcloud/stackit-cli/actions/workflows/release.yaml) will build the release and publish it on GitHub +5. Ensure the release was created properly using the [releases page](https://github.com/stackitcloud/stackit-cli/releases) +