RELEASE.md

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, 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)
• Changelog entries were added to the CHANGELOG.md file of the service to be released (see e.g. here)

Releasing a single service

1. Check out latest main branch on your machine
2. Create git tag: git tag services/<SERVICE-NAME>/vX.X.X
   • E.g. for the sqlserverflex service version v1.0.1 the git tag would be named services/sqlserverflex/v1.0.1
3. Push the git tag: git push origin --tags

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)

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) to your clipboard.
5. Go to the releases page 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 to see what it should look like). Then create and publish the GitHub release.