Skip to content

Commit 9af03bf

Browse files
authored
chore(doc): add documentation of release process (#1840)
relates to STACKITTPR-200
1 parent 9f5e922 commit 9af03bf

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

README.md

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

229229
Your contribution is welcome! For more details on how to contribute, refer to our [Contribution Guide](./CONTRIBUTION.md).
230230

231+
## Release creation
232+
233+
See the [release documentation](./RELEASE.md) for further information.
234+
231235
## License
232236

233237
Apache 2.0

RELEASE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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-go/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-go/blob/f1e375a38064f798821d22a951bc74ca8a9c8845/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-go/blob/f1e375a38064f798821d22a951bc74ca8a9c8845/services/dns/CHANGELOG.md))
17+
18+
**Releasing a single service**
19+
20+
1. Check out latest main branch on your machine
21+
2. Create git tag: `git tag services/<SERVICE-NAME>/vX.X.X`
22+
- E.g. for the `sqlserverflex` service version `v1.0.1` the git tag would be named `services/sqlserverflex/v1.0.1`
23+
3. Push the git tag: `git push origin --tags`
24+
25+
### Whole SDK
26+
27+
**Checklist before releasing the whole SDK**
28+
29+
- [ ] Date was set/updated in the `CHANGELOG.md` file in the root directory of the repository (see [here](https://github.com/stackitcloud/stackit-sdk-go/blob/f1e375a38064f798821d22a951bc74ca8a9c8845/CHANGELOG.md))
30+
31+
**Releasing the whole SDK**
32+
33+
> [!IMPORTANT]
34+
> Consider informing / syncing with the team before creating a new release.
35+
36+
1. Check out latest main branch on your machine
37+
2. Create git tag: `git tag release-YYYY-MM-DD`
38+
3. Push the git tag: `git push origin --tags`
39+
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-go/blob/f1e375a38064f798821d22a951bc74ca8a9c8845/CHANGELOG.md)) to your clipboard.
40+
5. Go to the [releases page](https://github.com/stackitcloud/stackit-sdk-go/releases) on GitHub and create a new release. Select the git tag you just created.
41+
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-go/releases/tag/release-2025-03-27) to see what it should look like). Then create and publish the GitHub release.
42+

0 commit comments

Comments
 (0)