kubernetes / ingress-nginx

Ingress NGINX Controller for Kubernetes
https://kubernetes.github.io/ingress-nginx/
Apache License 2.0
17.47k stars 8.25k forks source link

Chart: Changelogs not contained in GitHub releases. #10599

Closed lexfrei closed 4 weeks ago

lexfrei commented 1 year ago

Looks like, the chart should generate and post chengelog somewhere.

Currently, there are no changelogs posted in releases for chart.

We really need to know about breaking changes, like https://github.com/kubernetes/ingress-nginx/pull/10393

Also, this breaking change is not mentioned in chart's changelog and it's a problem. As chart user, I can't expect so big change without a line in changelog.

k8s-ci-robot commented 1 year ago

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
longwuyuan commented 1 year ago

/remove-kind bug Do you mean this needs to change https://github.com/kubernetes/ingress-nginx/blob/main/charts/ingress-nginx/changelog/Changelog-4.8.3.md

strongjz commented 1 year ago

We could add a link to the controller release notes in the helm release notes,

The controller and helm charts have a separate release cadence.

We always update the support table that maps controller to chart https://github.com/kubernetes/ingress-nginx#supported-versions-table

Gacko commented 11 months ago

/assign

lexfrei commented 11 months ago

Let me explain.

  1. There are no changelogs on release pages. Yes, it's possible to find, but it's not easy. We are expecting them on a release page.
  2. It's not fine to change behaviour without mentioning it. The chart is a separate product and it's not clear how it handles changes in the controller. I can't expect such a big change of behaviour in a minor version without a BIG RED ALERT MESSAGE.
Gacko commented 11 months ago

I guess all @lexfrei wants is something adding the content of the generated changelog file to be included in the Helm chart releases.

This mage step generates the changelog: https://github.com/kubernetes/ingress-nginx/blob/main/magefiles/steps/release.go This action generates the helm-chart-* releases: https://github.com/kubernetes/ingress-nginx/blob/main/.github/workflows/helm.yaml

btw: I also have a PR open for improving the way those changelogs are getting named & templated: https://github.com/kubernetes/ingress-nginx/pull/10622

I could try to improve the action so it also contains the changelog's content.

Gacko commented 9 months ago

/retitle Chart: Changelogs not contained in GitHub releases.

lusu007 commented 3 months ago

Any news on this?

Gacko commented 4 weeks ago

See https://github.com/kubernetes/ingress-nginx/pull/10718#issuecomment-2397480543.