diff --git a/docs/contributor/assets/release-workflow.png b/docs/contributor/assets/release-workflow.png new file mode 100644 index 0000000000..3a9e674312 Binary files /dev/null and b/docs/contributor/assets/release-workflow.png differ diff --git a/docs/contributor/releasing.md b/docs/contributor/releasing.md index 98525c5b05..9eb4f0e5d1 100644 --- a/docs/contributor/releasing.md +++ b/docs/contributor/releasing.md @@ -1,8 +1,11 @@ # Releasing +## Automated releases (WIP) +![](assets/release-workflow.png) + ## Release Process -This release process covers the steps to release new major and minor versions for the Kyma Telemetry module. +This release process covers the steps to release new major and minor versions for the Kyma Telemetry module. Together with the module release, prepare a new release of the [opentelemetry-collector-components](https://github.com/kyma-project/opentelemetry-collector-components). You will need this later in the release process of the Telemetry Manager. The version of `opentelemetry-collector-components` will include the Telemetry Manager version as part of its version (`{CURRENT_OCC_VERSION}-{TELEMETRY_MANAGER_VERSION}`). @@ -23,18 +26,18 @@ Together with the module release, prepare a new release of the [opentelemetry-co 5. Bump the `telemetry-manager/{RELEASE_BRANCH}` branch with the new versions for the dependent images. Create a PR to `telemetry-manager/{RELEASE_BRANCH}` with the following changes: - - Update Docker images in the `.env` file: + - Update Docker images in the `.env` file: - Update the `ENV_IMG` variable, update the tag of the `telemetry-manager` image with the new module version following the `x.y.z` pattern. For example, `ENV_IMG=europe-docker.pkg.dev/kyma-project/prod/telemetry-manager:1.0.0`. - Update the `DEFAULT_OTEL_COLLECTOR_IMAGE` variable, update the tag of the `kyma-otel-collector` image with the new version released from the [opentelemetry-collector-components](https://github.com/kyma-project/opentelemetry-collector-components) repository. For example, `DEFAULT_OTEL_COLLECTOR_IMAGE=europe-docker.pkg.dev/kyma-project/prod/kyma-otel-collector:0.100.0-1.0.0`. - - Update `config/manager/kustomization.yaml`: + - Update `config/manager/kustomization.yaml`: - Update the `newTag` field for the `telemetry-manager` image with the new module version following the `x.y.z` pattern, such as `1.0.0`. - Update `main.go`: - Update the `version` variable with the new module version following the `x.y.z` pattern. - `make generate` - Run `make generate` to update the images in the `sec-scanners-config.yaml` and other files. - + 6. Merge the PR. - + 7. To make sure that the release tags point to the HEAD commit of the `telemetry-manager/{RELEASE_BRANCH}` branch, rebase the upstream branch into the local branch after the merge was successful. ```bash