Invalid artifacthub.io/changes annotation in Helm chart

[tegioz]

Hi!

This is Sergio, from Artifact Hub 👋

The entries in the AH changes annotation in the ingress-nginx Chart.yaml file are not valid. I think this issue was introduced in this commit. To use the # character the strings should be quoted.

- "#8120    Update go in runner and release v1.1.1"
- "#8119    Update to go v1.17.6"
- "#8118    Remove deprecated libraries, update other libs"

This issue has caused the last versions of ingress-nginx to not be listed on Artifact Hub. All members of the owning organization (Kubernetes) should have received an email notification about this issue (except the ones who opted-out of the tracking errors notifications) for each of the failed versions. This error is also visible from the control panel:

It'd be great if you could fix it, as there are a lot of users subscribed to this package (the one with the most subscriptions on AH!) that may have missed notifications (email/webhook) about the new releases.

Just in case you didn't know, it's also possible to provide the changes in a structured format to provide an even better experience in Artifact Hub (please see screenshot below). You can see an example of this format in the Artifact Hub Helm annotations documentation.

Cheers.-

[k8s-ci-robot]

@tegioz: 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[kundan2707]

/assign

[tegioz]

Just in case it helps, AH has a linter that you can include in your CI workflows to catch this kind of errors early on. You can see an example of how it can be integrated here.

[longwuyuan]

@tegioz thanks so much for helping us understand this, This was a mystery as to why the latest release was not showing up.

Is this a a valid line ;

- [8120](https://github.com/kubernetes/ingress-nginx/pull/8120)    Update go in runner and release v1.1.1 

[longwuyuan]

@kundan2707 can we talk on slack about this.

[tegioz]

No worries 🙂

I don't think so, when using certain characters in yaml (like {}:[],&*#?|-<>=!%@) it's best to quote them. Also, the changes view won't display markdown that way, so those links wouldn't be displayed as you may expect. If you want to include links I'd suggest using the structured format that supports them:

  - kind: added
    description: Packages views are now being tracked
    links:
      - name: pg_partman extension is now required
        url: https://github.com/pgpartman/pg_partman

[longwuyuan]

@tegioz , thanks tons for this help. I was attempting to have links show up in the changelog and hence we landed here. How do others do it normally. Does everyone use the structured format. I don't think it will make it easier for us to use structured format as we are generating the changelog manually https://github.com/kubernetes/ingress-nginx/blob/main/RELEASE.md . So we might as well just remove the "#" character.

Please advise if just removing the "#" seems like a better approach, given our circumstances now.

[tegioz]

You can also quote the full string if you'd like to keep it, this should work fine:

- "#8120    Update go in runner and release v1.1.1"
- "#8119    Update to go v1.17.6"
- "#8118    Remove deprecated libraries, update other libs"

[longwuyuan]

Thanks a lot again. This helps a lot. Kundan kindly let us sync on slack. RELEASE.md also needs update accordingly. Thanks, ; Long

…

On Thu, 27 Jan, 2022, 8:56 PM Sergio C. Arteaga, ***@***.***> wrote: You can also quote the full string if you'd like to keep it, this should work fine: - "#8120 Update go in runner and release v1.1.1" - "#8119 Update to go v1.17.6" - "#8118 Remove deprecated libraries, update other libs" — Reply to this email directly, view it on GitHub <#8197 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWW2QMY6IXYIUOPRW7DUYFP2ZANCNFSM5M5MVWFQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you commented.Message ID: ***@***.***>

[tao12345666333]

Just open a PR to add ah lint and fix the wrong format. #8204