You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributor/releasing.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,14 +13,14 @@ The release process uses GitHub Actions workflows to automate the following task
13
13
14
14
## Prerequisites
15
15
16
-
1.**Milestone Verification**: You must close all issues in the [GitHub milestone](https://github.com/kyma-project/telemetry-manager/milestones) for the version and close the milestone. Create a new [GitHub milestone](https://github.com/kyma-project/telemetry-manager/milestones) for the next version.
16
+
1.**Milestone Verification**: Close all issues in the [GitHub milestone](https://github.com/kyma-project/telemetry-manager/milestones) for the version and close the milestone. Create a new [GitHub milestone](https://github.com/kyma-project/telemetry-manager/milestones) for the next version.
17
17
18
-
2.**Component Releases**: You must release the following component dependencies:
19
-
-[directory-size-exporter](https://github.com/kyma-project/telemetry-manager/actions/workflows/build-directory-size-reporter-image.yml)(produces image tags like `v20260302-12345678`)
20
-
-[telemetry-self-monitor](https://github.com/kyma-project/telemetry-manager/actions/workflows/build-self-monitor-image.yml)(produces image tags like `v20260302-bbf32a3b`)
21
-
-[opentelemetry-collector-components](https://github.com/kyma-project/opentelemetry-collector-components)(version format: **`{OCC_VERSION}`**-**`{TELEMETRY_VERSION}`**, such as `0.100.0-1.2.3`)
18
+
2.**Component Releases**: Release the following component dependencies:
19
+
-[directory-size-exporter](https://github.com/kyma-project/telemetry-manager/actions/workflows/build-directory-size-reporter-image.yml)- Produces image tags like `v20260302-12345678`
20
+
-[telemetry-self-monitor](https://github.com/kyma-project/telemetry-manager/actions/workflows/build-self-monitor-image.yml)- Produces image tags like `v20260302-bbf32a3b`
21
+
-[opentelemetry-collector-components](https://github.com/kyma-project/opentelemetry-collector-components)- Version format: **`{OCC_VERSION}`**-**`{TELEMETRY_VERSION}`**, such as `0.100.0-1.2.3`
22
22
23
-
3.**Docker Image Availability**: You must verify that the required Docker images exist:
23
+
3.**Docker Image Availability**: Verify that the required Docker images exist:
4.**Access Requirements**: You must have the following permissions:
35
+
4.**Access Requirements**: Ensure you have the following permissions:
36
36
- Write access to the telemetry-manager repository
37
37
- Access to merge PRs on the release branch
38
38
@@ -53,7 +53,7 @@ In the telemetry-manager repo, go to **Actions**, select [Telemetry Release](htt
53
53
|**force**| Recreate existing release (use with caution) ||
54
54
|**module_release**| Trigger module release for experimental and fast channels after release ||
55
55
56
-
To test the release process without creating actual tags or releases, set `dry_run` to `true`. This validates the workflow and catches any issues before you perform the real release.
56
+
To test the release process without creating actual tags or releases, set `dry_run` to `true`. This setting validates the workflow and catches any issues before you perform the real release.
57
57
The `force` option re-creates an existing release by deleting the existing tag and release before creating a new one. Use this option with caution. It overwrites the existing release.
58
58
The `module_release` option controls whether the workflow automatically triggers module releases for the experimental and fast channels after the workflow creates the main release. By default, the workflow creates module releases for the experimental and fast channels. Set this option to `false` to skip module releases or to trigger them manually later.
59
59
@@ -74,7 +74,7 @@ The workflow automatically validates the following conditions:
74
74
- The image tag format matches the expected pattern (`vYYYYMMDD-HASH`).
75
75
- All required Docker images exist in the registry.
76
76
- The milestone exists, is closed, and has no open issues.
77
-
- No existing release or tag conflicts with the target version (skipped if force mode is enabled).
77
+
- No existing release or tag conflicts with the target version. This check is skipped if force mode is enabled.
78
78
- The release branch exists for a patch release, or a new branch is needed for a minor/major release.
79
79
80
80
If validation fails, the workflow stops and reports the error.
@@ -99,7 +99,7 @@ First, the workflow updates the following variables in the `.env` file with the
99
99
Next, the workflow runs the `make generate` command to apply these changes to all auto-generated files, such as the Helm chart manifests.
100
100
101
101
> [!WARNING]
102
-
> The workflow waits up to 120 minutes for you to review and merge the PR. If you do not merge the PR within 120 minutes, the workflow times out and fails.
102
+
> If you do not merge the PR within 120 minutes, the workflow times out and fails. The workflow waits up to 120 minutes for you to review and merge the PR.
103
103
To review the PR, use the checklist in the PR description to verify the following conditions:
104
104
-[ ] Version numbers are correct
105
105
-[ ] Generated files are up to date
@@ -122,8 +122,8 @@ After all tests pass, the workflow creates the release by performing the followi
122
122
123
123
1. Creates annotated Git tag: **`{VERSION}`**
124
124
2. Pushes the tag to trigger the following processes:
125
-
-Builds and pushes the Docker image (the workflow uses `build-manager-image.yml`)
126
-
-Creates the release (the workflow uses goreleaser)
125
+
-The workflow uses `build-manager-image.yml` to build and push the Docker image
126
+
-The workflow uses goreleaser to create the release
127
127
3. Packages Helm chart
128
128
4. Uploads Helm chart to the GitHub release
129
129
5. Updates `gh-pages` branch with Helm repository index
@@ -154,10 +154,10 @@ If all checks pass, the workflow merges both PRs automatically.
154
154
To release to the regular channel, manually trigger the module release workflow:
155
155
156
156
In the telemetry-manager repo, go to **Actions**, select [Telemetry Module Release](https://github.com/kyma-project/telemetry-manager/actions/workflows/module-release.yml), and run the workflow with the following inputs:
Check PRs for both experimental and fast channels in the [module-manifests repository](https://github.tools.sap/kyma/module-manifests/pulls).
189
+
Check the PRs for both experimental and fast channels in the [module-manifests repository](https://github.tools.sap/kyma/module-manifests/pulls).
190
190
191
191
## Troubleshooting
192
192
@@ -226,13 +226,13 @@ The workflow waits for a maximum of 120 minutes for you to merge the PR. If you
226
226
227
227
## Post-Release Tasks
228
228
229
-
After the release completes, you must perform the following tasks:
229
+
After the release completes, perform the following tasks:
230
230
- To verify the release, check [Releases](https://github.com/kyma-project/telemetry-manager/releases). A successful release produces the following artifacts:
- Helm chart: `telemetry-`**`{VERSION}`**`.tgz` (attached to GitHub release)
235
-
- Module manifest PRs in the `kyma/module-manifests` repository for experimental and fast channels (if `module_release=true`)
234
+
- Helm chart: `telemetry-`**`{VERSION}`**`.tgz`, attached to GitHub release
235
+
- Module manifest PRs in the `kyma/module-manifests` repository for experimental and fast channels if `module_release=true`
236
236
- Review the auto-generated release notes. If you cherry-picked commits for the release, some changes might appear duplicated. Edit the release notes to correct this.
0 commit comments