Skip to content

[Bug]: Docs: No changelog for Helm chart versions (e.g., between 2.2.0 and 2.2.1) #8040

@IceHamster

Description

@IceHamster

Version

edge

What Kubernetes platforms are you running on?

AKS Azure

Steps to reproduce

There is no documented changelog or release notes for updates to the nginx-ingress Helm chart published at oci://ghcr.io/nginx/charts/nginx-ingress.

Recently, the chart was updated from version 2.2.0 to 2.2.1. However, there is no information available in the project's GitHub releases, documentation, or any CHANGELOG.md file that details the changes between these two versions.

The GitHub release tags (e.g., v5.1.0) correspond to the appVersion of the NGINX Ingress Controller application, not the Helm chart's version. For example, the v5.1.0 release tag points to a Chart.yaml with version: 2.2.0. This makes it impossible for users to track chart-specific changes through the existing release process.

This forces users to manually download and diff the chart versions to understand the impact of an upgrade, which is unreliable and time-consuming.

  1. Observe the available chart versions in the OCI registry. The latest is 2.2.1.
    ❯ helm show chart oci://ghcr.io/nginx/charts/nginx-ingress
    name: nginx-ingress
    version: 2.2.1
    appVersion: 5.1.0
    ...
  2. Check the GitHub releases page for a changelog for chart version 2.2.1. No such release exists.
  3. Check the latest relevant application release, v5.1.0. The Chart.yaml in this tag specifies version: 2.2.0, not 2.2.1.
    https://github.com/nginx/kubernetes-ingress/blob/v5.1.0/charts/nginx-ingress/Chart.yaml
  4. To find the changes, one must manually pull and compare the two chart versions:
    # Create directories for each version
    helm pull oci://ghcr.io/nginx/charts/nginx-ingress --version 2.2.0 -d 2.2.0 --untar
    helm pull oci://ghcr.io/nginx/charts/nginx-ingress --version 2.2.1 -d 2.2.1 --untar
    
    # Diff the directories
    diff -r 2.2.0/nginx-ingress 2.2.1/nginx-ingress
  5. The diff reveals a change to the nginx-connect.endpointHost value, but this had to be discovered manually:
    diff -r 2.2.0/nginx-ingress/values.yaml 2.2.1/nginx-ingress/values.yaml
    673c673
    <   endpointHost: "product.connect.nginx.com"
    ---
    >   endpointHost: "agent.connect.nginx.com"

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugAn issue reporting a potential bugneeds triageAn issue that needs to be triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions