Skip to content

chore(docs): add release process documentation #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2025
Merged

chore(docs): add release process documentation #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Release

## Release cycle

A release of the whole SDK should be created at least every 2 weeks.

## Release creation

### Single service

The SDK is split into all the different STACKIT [services](https://github.com/stackitcloud/stackit-sdk-java/tree/main/services), each of them having their own version numbers.

**Checklist before releasing a single service**

- [ ] Changelog entries were added to the `CHANGELOG.md` in the root directory of the repository (see [here](https://github.com/stackitcloud/stackit-sdk-java/blob/43cca15713638623ce56f58a4b93836c548cb05c/CHANGELOG.md))
- [ ] Changelog entries were added to the `CHANGELOG.md` file of the service to be released (see e.g. [here](https://github.com/stackitcloud/stackit-sdk-java/blob/43cca15713638623ce56f58a4b93836c548cb05c/services/resourcemanager/CHANGELOG.md))

**Releasing a single service**

1. Update the VERSION file of the corresponding service
2. When the PR is merged to main the tag is created automatically

### Whole SDK

**Checklist before releasing the whole SDK**

- [ ] Date was set/updated in the `CHANGELOG.md` file in the root directory of the repository (see [here](https://github.com/stackitcloud/stackit-sdk-java/blob/43cca15713638623ce56f58a4b93836c548cb05c/CHANGELOG.md))

**Releasing the whole SDK**

> [!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 release-YYYY-MM-DD`
3. Push the git tag: `git push origin --tags`
4. Copy the changelog entries for the new release from the `CHANGELOG.md` file in the root directory of the repository (see [here](https://github.com/stackitcloud/stackit-sdk-java/blob/43cca15713638623ce56f58a4b93836c548cb05c/CHANGELOG.md)) to your clipboard.
5. Go to the [releases page](https://github.com/stackitcloud/stackit-sdk-java/releases) on GitHub and create a new release. Select the git tag you just created.
6. Before creating the GitHub release, add the *Highlights* heading at the top of the markdown description and paste the changelog entries from your clipboard (see [previous releases](https://github.com/stackitcloud/stackit-sdk-java/releases/tag/release-2025-09-09) to see what it should look like). Then create and publish the GitHub release.