Skip to content

Commit e1a0243

Browse files
committed
update release doc
1 parent 1916bcd commit e1a0243

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/contributor/releasing.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ The release process uses GitHub Actions workflows to automate the following task
1313

1414
## Prerequisites
1515

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.
1717

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`
2222

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:
2424
```bash
2525
# Check OCC image
2626
docker manifest inspect europe-docker.pkg.dev/kyma-project/prod/kyma-otel-collector:**{OCC_VERSION}**
@@ -32,7 +32,7 @@ The release process uses GitHub Actions workflows to automate the following task
3232
docker manifest inspect europe-docker.pkg.dev/kyma-project/prod/tpi/telemetry-self-monitor:**{SELF_MONITOR_TAG}**
3333
```
3434

35-
4. **Access Requirements**: You must have the following permissions:
35+
4. **Access Requirements**: Ensure you have the following permissions:
3636
- Write access to the telemetry-manager repository
3737
- Access to merge PRs on the release branch
3838

@@ -53,7 +53,7 @@ In the telemetry-manager repo, go to **Actions**, select [Telemetry Release](htt
5353
| **force** | Recreate existing release (use with caution) | |
5454
| **module_release** | Trigger module release for experimental and fast channels after release | |
5555

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.
5757
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.
5858
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.
5959

@@ -74,7 +74,7 @@ The workflow automatically validates the following conditions:
7474
- The image tag format matches the expected pattern (`vYYYYMMDD-HASH`).
7575
- All required Docker images exist in the registry.
7676
- 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.
7878
- The release branch exists for a patch release, or a new branch is needed for a minor/major release.
7979

8080
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
9999
Next, the workflow runs the `make generate` command to apply these changes to all auto-generated files, such as the Helm chart manifests.
100100

101101
> [!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.
103103
To review the PR, use the checklist in the PR description to verify the following conditions:
104104
- [ ] Version numbers are correct
105105
- [ ] Generated files are up to date
@@ -122,8 +122,8 @@ After all tests pass, the workflow creates the release by performing the followi
122122

123123
1. Creates annotated Git tag: **`{VERSION}`**
124124
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
127127
3. Packages Helm chart
128128
4. Uploads Helm chart to the GitHub release
129129
5. Updates `gh-pages` branch with Helm repository index
@@ -154,10 +154,10 @@ If all checks pass, the workflow merges both PRs automatically.
154154
To release to the regular channel, manually trigger the module release workflow:
155155

156156
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:
157-
- **version**: **`{VERSION}`** (for example, `1.2.3`)
157+
- **version**: **`{VERSION}`**, such as `1.2.3`
158158
- **channel**: `regular`
159159
- **dry_run**: `false`
160-
- **auto_merge**: `true` (or `false` for manual merge)
160+
- **auto_merge**: `true` or `false` for manual merge
161161

162162
## Release Channels
163163

@@ -186,7 +186,7 @@ Monitor the release workflow at: [Actions > Telemetry Release](https://github.co
186186

187187
Monitor module releases at: [Actions > Telemetry Module Release](https://github.com/kyma-project/telemetry-manager/actions/workflows/module-release.yml)
188188

189-
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).
190190

191191
## Troubleshooting
192192

@@ -226,13 +226,13 @@ The workflow waits for a maximum of 120 minutes for you to merge the PR. If you
226226

227227
## Post-Release Tasks
228228

229-
After the release completes, you must perform the following tasks:
229+
After the release completes, perform the following tasks:
230230
- To verify the release, check [Releases](https://github.com/kyma-project/telemetry-manager/releases). A successful release produces the following artifacts:
231231
- Git tag: **`{VERSION}`**
232232
- GitHub release with auto-generated changelog
233233
- Docker image: `europe-docker.pkg.dev/kyma-project/prod/telemetry-manager:`**`{VERSION}`**
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`)
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`
236236
- 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.
237237

238238
## Related Workflows

0 commit comments

Comments
 (0)