Skip to content

Commit bce05fb

Browse files
authored
chore(doc): add documentation of release process (#769)
relates to STACKITTPR-200
1 parent 44f67ad commit bce05fb

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

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

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

225+
## Release creation
226+
227+
See the [release documentation](./RELEASE.md) for further information.
228+
225229
## License
226230

227231
Apache 2.0

RELEASE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Release
2+
3+
## Release cycle
4+
5+
A release should be created at least every 2 weeks.
6+
7+
## Release creation
8+
9+
> [!IMPORTANT]
10+
> Consider informing / syncing with the team before creating a new release.
11+
12+
1. Check out latest main branch on your machine
13+
2. Create git tag: `git tag vX.X.X`
14+
3. Push the git tag: `git push origin --tags`
15+
4. The [release pipeline](https://github.com/stackitcloud/terraform-provider-stackit/actions/workflows/release.yaml) will build the release and publish it on GitHub
16+
5. Ensure the release was created properly using the
17+
- [GitHub releases page](https://github.com/stackitcloud/terraform-provider-stackit/releases)
18+
- [Terraform registry](https://registry.terraform.io/providers/stackitcloud/stackit/latest)
19+
20+
## Troubleshooting
21+
22+
In case the release only shows up as a draft release in the Terraform registry, check the state of the registry update in the [settings](https://github.com/stackitcloud/terraform-provider-stackit/settings/hooks):
23+
24+
- Select 'edit' for the terraform registry webhook (requires authentication)
25+
- Switch to the "recent deliveries" tab
26+
- Check the last release, it should have positive result value and no error indication
27+
28+
If the delivery failed or complains that the release is a draft, try to temporariliy declare the release as a pre-release in GitHub and then revert it it immediately.

0 commit comments

Comments
 (0)