From 62a93e777e16ba7e7e2348554b026daa0e37f92c Mon Sep 17 00:00:00 2001 From: Gandalf Date: Sat, 16 May 2026 12:27:49 -0300 Subject: [PATCH 1/2] docs(plugin-bc-correios): add v1.1 upgrade guide Requested-by: @guimoreirar --- charts/plugin-bc-correios/docs/UPGRADE-1.1.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 charts/plugin-bc-correios/docs/UPGRADE-1.1.md diff --git a/charts/plugin-bc-correios/docs/UPGRADE-1.1.md b/charts/plugin-bc-correios/docs/UPGRADE-1.1.md new file mode 100644 index 00000000..8e377c24 --- /dev/null +++ b/charts/plugin-bc-correios/docs/UPGRADE-1.1.md @@ -0,0 +1,69 @@ +# Helm Upgrade from v1.0.x to v1.1.x +## Topics +- **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** + +## Overview +This guide covers the `plugin-bc-correios` chart upgrade from `1.0.1` to `1.1.0-beta.1`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored. + +Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults. + +## Version changes + +| Field | Previous | Current | +|-------|----------|---------| +| Chart version | `1.0.1` | `1.1.0-beta.1` | +| App version | `1.0.0` | `1.2.0` | + +## Configuration changes + +### Added values + +```yaml +br-spb-bc-correios.image.tag: "1.2.0" +``` + +### Removed values + +_No direct values.yaml key changes detected._ + +### Changed operational values + +_No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ + +## Template changes + +### Added files + +- No chart files added. + +### Removed files + +- No chart files removed. + +### Modified files + +- `charts/plugin-bc-correios/Chart.yaml` +- `charts/plugin-bc-correios/values.yaml` + +## Migration steps + +1. Read this guide and compare your custom values against `charts/plugin-bc-correios/values.yaml`. +2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. +3. Render the chart locally with your production values and review the manifest diff. +4. Apply the upgrade in a controlled environment before production. + +## Preview changes before upgrading + +```bash +helm diff upgrade plugin-bc-correios ./charts/plugin-bc-correios \ + --namespace \ + --values +``` + +## Command to upgrade + +```bash +helm upgrade plugin-bc-correios ./charts/plugin-bc-correios \ + --namespace \ + --values +``` From babca742edde1f34c4ac88e6d18b38456e234169 Mon Sep 17 00:00:00 2001 From: Gandalf Date: Fri, 29 May 2026 11:47:44 -0300 Subject: [PATCH 2/2] docs(plugin-bc-correios): align upgrade guide format Requested-by: @guimoreirar --- charts/plugin-bc-correios/docs/UPGRADE-1.1.md | 108 ++++++++++++------ 1 file changed, 74 insertions(+), 34 deletions(-) diff --git a/charts/plugin-bc-correios/docs/UPGRADE-1.1.md b/charts/plugin-bc-correios/docs/UPGRADE-1.1.md index 8e377c24..e3f7ef33 100644 --- a/charts/plugin-bc-correios/docs/UPGRADE-1.1.md +++ b/charts/plugin-bc-correios/docs/UPGRADE-1.1.md @@ -1,69 +1,109 @@ # Helm Upgrade from v1.0.x to v1.1.x + ## Topics -- **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** + +- **[Overview](#overview)** +- **[Features](#features)** + - [1. Application version bump to 1.2.0](#1-application-version-bump-to-120) + - [2. br-spb-bc-correios sibling image tag pinned](#2-br-spb-bc-correios-sibling-image-tag-pinned) +- **[Configuration Changes](#configuration-changes)** +- **[Migration Steps](#migration-steps)** +- **[Preview changes before upgrading](#preview-changes-before-upgrading)** +- **[Command to upgrade](#command-to-upgrade)** ## Overview -This guide covers the `plugin-bc-correios` chart upgrade from `1.0.1` to `1.1.0-beta.1`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored. -Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults. +This is a minor release that updates the application version of the BC Correios plugin and pins the image tag of the `br-spb-bc-correios` sibling component. No breaking changes are introduced and no manual data migration is required. + +## Features + +### 1. Application version bump to 1.2.0 + +The chart now ships with `appVersion` `1.2.0`, replacing the previous `1.0.0`. The chart version itself moves from `1.0.1` to `1.1.0-beta.1`. -## Version changes +| Component | v1.0.1 | v1.1.0-beta.1 | +|-------------|---------|-----------------| +| version | 1.0.1 | 1.1.0-beta.1 | +| appVersion | 1.0.0 | 1.2.0 | -| Field | Previous | Current | -|-------|----------|---------| -| Chart version | `1.0.1` | `1.1.0-beta.1` | -| App version | `1.0.0` | `1.2.0` | +The `bc-correios.image.tag` value in `values.yaml` still defaults to `"1.0.0"`. The runtime image tag is rendered by the CI/CD pipeline through the existing `helm_values_key_mappings` declared in `values.yaml`: -## Configuration changes +```yaml +# helm_values_key_mappings: '{"plugin-bc-correios": "bc-correios"}' +``` -### Added values +If you set `bc-correios.image.tag` explicitly in your overrides, align it with the new `appVersion`: ```yaml -br-spb-bc-correios.image.tag: "1.2.0" +bc-correios: + image: + repository: lerianstudio/plugin-bc-correios + tag: "1.2.0" ``` -### Removed values +> **Note:** For application-level changes included in version 1.2.0, refer to the [plugin-bc-correios changelog](https://github.com/LerianStudio/plugin-bc-correios). + +### 2. br-spb-bc-correios sibling image tag pinned -_No direct values.yaml key changes detected._ +A new top-level `br-spb-bc-correios` block is added to `values.yaml`, pinning the image tag of the sibling SPB BC Correios component to `1.2.0`. -### Changed operational values +| Component | v1.0.1 | v1.1.0-beta.1 | +|--------------------------------|---------|---------------| +| br-spb-bc-correios.image.tag | _unset_ | 1.2.0 | -_No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ +```yaml +br-spb-bc-correios: + image: + tag: 1.2.0 +``` -## Template changes +If you already override this value, review your override against the new chart default. No other keys are introduced. -### Added files +## Configuration Changes -- No chart files added. +No keys are removed or renamed in this release. The following table summarizes the value changes: -### Removed files +| Setting | v1.0.1 | v1.1.0-beta.1 | +|------------------------------|---------|---------------| +| Chart `version` | 1.0.1 | 1.1.0-beta.1 | +| Chart `appVersion` | 1.0.0 | 1.2.0 | +| `br-spb-bc-correios.image.tag` | _unset_ | 1.2.0 | -- No chart files removed. +All existing `values.yaml` settings remain compatible with version 1.1.0-beta.1. -### Modified files +## Migration Steps -- `charts/plugin-bc-correios/Chart.yaml` -- `charts/plugin-bc-correios/values.yaml` +This upgrade requires no manual migration steps. The Helm upgrade will roll the pods with the new image tags. -## Migration steps +**Recommended upgrade process:** -1. Read this guide and compare your custom values against `charts/plugin-bc-correios/values.yaml`. -2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. -3. Render the chart locally with your production values and review the manifest diff. -4. Apply the upgrade in a controlled environment before production. +1. Review the changes using the helm-diff plugin (see [Preview changes before upgrading](#preview-changes-before-upgrading)) +2. Ensure you have a recent backup of your data (if using chart-managed databases) +3. Run the upgrade command during a maintenance window +4. Verify all pods are running and healthy after the upgrade + +```bash +kubectl get pods -n +``` + +5. Check service logs for any startup issues + +```bash +kubectl logs -n -l app.kubernetes.io/name=plugin-bc-correios-helm --tail=50 +``` + +> **Note:** The upgrade will trigger a rolling restart of the BC Correios pods. Depending on your replica count and readiness probe configuration, this may cause brief service interruptions. ## Preview changes before upgrading ```bash -helm diff upgrade plugin-bc-correios ./charts/plugin-bc-correios \ - --namespace \ - --values +helm diff upgrade plugin-bc-correios oci://registry-1.docker.io/lerianstudio/plugin-bc-correios-helm --version 1.1.0-beta.1 -n ``` +> **Note:** Requires the [helm-diff plugin](https://github.com/databus23/helm-diff). Install with: `helm plugin install https://github.com/databus23/helm-diff` + ## Command to upgrade ```bash -helm upgrade plugin-bc-correios ./charts/plugin-bc-correios \ - --namespace \ - --values +helm upgrade plugin-bc-correios oci://registry-1.docker.io/lerianstudio/plugin-bc-correios-helm --version 1.1.0-beta.1 -n ```