Skip to content
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.

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

Support artifacthub's 'artifacthub.io/changes' annotation for Helm release changelogs #13385

Open
Tracked by #14138
onedr0p opened this issue Jan 5, 2022 · 5 comments
Labels
auto:reproduction A minimal reproduction is necessary to proceed core:changelogs Related to changelogs/release notes fetching priority-4-low Low priority, unlikely to be done unless it becomes important to more people status:blocked Issue is blocked by another issue or external requirement type:feature Feature (new functionality)

Comments

@onedr0p
Copy link
Contributor

onedr0p commented Jan 5, 2022

What would you like Renovate to be able to do?

It would be neat if renovate could render a changelog from the artifacthub.io/changes field in the Helm charts's Chart.yaml

artifacthub.io/changes is explained here: https://artifacthub.io/docs/topics/annotations/helm/

This is set by either an array contained in a string:

# Chart.yaml
...
annotations:
  artifacthub.io/changes: |
    - kind: added
      description: Cool feature
      links:
        - name: Github Issue
          url: https://github.com/issue-url
        - name: Github PR
          url: https://github.com/pr-url
    - kind: fixed
      description: Minor bug
      links:
        - name: Github Issue
          url: https://github.com/issue-url
...

or by a simple string:

# Chart.yaml
...
annotations:
  artifacthub.io/changes: |
    - Added cool feature
    - Fixed minor bug
...

If you have any ideas on how this should be implemented, please tell us here.

I haven't found any other references to this artifacthub annotation.

Is this a feature you are interested in implementing yourself?

Maybe

@onedr0p onedr0p added priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started type:feature Feature (new functionality) labels Jan 5, 2022
@viceice
Copy link
Member

viceice commented Jan 5, 2022

Changelogs fetch needs a major rewrite before we can support new sources.

@viceice viceice added core:changelogs Related to changelogs/release notes fetching status:blocked Issue is blocked by another issue or external requirement and removed status:requirements Full requirements are not yet known, so implementation should not be started labels Jan 5, 2022
@onedr0p
Copy link
Contributor Author

onedr0p commented Jan 5, 2022

@viceice thanks for the info. Would you mind labeling this issue as manager:helm as well. Thanks again!

@viceice
Copy link
Member

viceice commented Jan 5, 2022

No, as changelogs are a completely different concept in renovate. There is no manager involved.

We don't plans to allow managers to intercept changelog processing.

@Preisschild
Copy link

To add some more information that might be relevant for implementation:

This would not require making requests to the artifacthub API. The changelog is written to the helm repos' index.yaml, which the helm datasource already downloads & parses here.

A short bash example with yq would be this (where the installed version is 6.4.0 and the latest version is 6.4.3) curl https://k8s-at-home.com/charts/index.yaml | yq '.entries.plex[] | select(.version <= "6.4.3") | select (.version > "6.4.0") | .annotations."artifacthub.io/changes"'.

@rarkins rarkins added auto:reproduction A minimal reproduction is necessary to proceed priority-4-low Low priority, unlikely to be done unless it becomes important to more people and removed priority-5-triage labels Nov 25, 2022
@github-actions
Copy link
Contributor

Hi there,

Get your issue fixed faster by creating a minimal reproduction. This means a repository dedicated to reproducing this issue with the minimal dependencies and config possible.

Before we start working on your issue we need to know exactly what's causing the current behavior. A minimal reproduction helps us with this.

To get started, please read our guide on creating a minimal reproduction.

We may close the issue if you, or someone else, haven't created a minimal reproduction within two weeks. If you need more time, or are stuck, please ask for help or more time in a comment.

Good luck,

The Renovate team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto:reproduction A minimal reproduction is necessary to proceed core:changelogs Related to changelogs/release notes fetching priority-4-low Low priority, unlikely to be done unless it becomes important to more people status:blocked Issue is blocked by another issue or external requirement type:feature Feature (new functionality)
Projects
None yet
Development

No branches or pull requests

4 participants