Skip to content

Commit 44d23b5

Browse files
authored
chore(docs): add release process documentation (#25)
relates to STACKITSDK-176
1 parent 43cca15 commit 44d23b5

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

RELEASE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Release
2+
3+
## Release cycle
4+
5+
A release of the whole SDK should be created at least every 2 weeks.
6+
7+
## Release creation
8+
9+
### Single service
10+
11+
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.
12+
13+
**Checklist before releasing a single service**
14+
15+
- [ ] 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))
16+
- [ ] 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))
17+
18+
**Releasing a single service**
19+
20+
1. Update the VERSION file of the corresponding service
21+
2. When the PR is merged to main the tag is created automatically
22+
23+
### Whole SDK
24+
25+
**Checklist before releasing the whole SDK**
26+
27+
- [ ] 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))
28+
29+
**Releasing the whole SDK**
30+
31+
> [!IMPORTANT]
32+
> Consider informing / syncing with the team before creating a new release.
33+
34+
1. Check out latest main branch on your machine
35+
2. Create git tag: `git tag release-YYYY-MM-DD`
36+
3. Push the git tag: `git push origin --tags`
37+
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.
38+
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.
39+
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.

0 commit comments

Comments
 (0)