Skip to content

chore: automated release process #1900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
k15r wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: automated release process #1900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/contributor/assets/release-workflow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions docs/contributor/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}`).

Expand All @@ -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
Expand Down
Loading