K3s changelog not displayed

[fmunteanu]

What would you like help with?

I would like help with my configuration

How are you running Renovate?

Mend Renovate hosted app on github.com

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

No response

Please tell us more about your question or problem

Using the documentation configuration:

{
  "customManagers": [
    {
      "customType": "regex",
      "fileMatch": ["k3s.version"],
      "matchStrings": ["(?<currentValue>\\S+)"],
      "depNameTemplate": "k3s",
      "versioningTemplate": "semver-coerced",
      "datasourceTemplate": "custom.k3s"
    }
  ],
  "customDatasources": {
    "k3s": {
      "defaultRegistryUrlTemplate": "https://update.k3s.io/v1-release/channels",
      "transformTemplates": [
        "{\"releases\":[{\"version\": $$.(data[id = 'stable'].latest),\"sourceUrl\":\"https://github.com/k3s-io/k3s\",\"changelogUrl\":$join([\"https://github.com/k3s-io/k3s/releases/tag/\",data[id = 'stable'].latest])}],\"sourceUrl\": \"https://github.com/k3s-io/k3s\",\"homepage\": \"https://k3s.io/\"}"
      ]
    }
  }
}

The release notes are not displayed into PR. I'm also not sure why sourceUrl is repeated twice, is it a requirement?

Logs (if relevant)

Logs

Replace this text with your logs, between the starting and ending triple backticks

[viceice]

remove changelog url

[fmunteanu]

@viceice Removing the changelog does not fixes the issue, unfortunately. I also removed the duplicate sourceUrl:

  "customDatasources": {
    "k3s": {
      "defaultRegistryUrlTemplate": "https://update.k3s.io/v1-release/channels",
      "transformTemplates": [
        "{\"releases\": [{\"version\": $$.(data[id = 'stable'].latest)}], \"homepage\": \"https://k3s.io/\", \"sourceUrl\": \"https://github.com/k3s-io/k3s\"}"
      ]
    }
  }

I would expect a format similar to this PR, where release notes are present:

  "customManagers": [
    {
      "customType": "regex",
      "datasourceTemplate": "github-releases",
      "depNameTemplate": "kubernetes-sigs/external-dns",
      "extractVersionTemplate": "^external-dns-helm-chart-(?<version>.+)$",
      "fileMatch": [
        "roles/cloudflare/defaults/main.yaml"
      ],
      "matchStrings": [
        "helm:\\s+chart:[\\s\\S]+?version:\\s+v(?<currentValue>.+)"
      ]
    }
  ]

[viceice]

I'm using the following jsonata, I never got the docs sample to work correctly.

https://github.com/visualon/renovate-config/blob/809f81d46a6c429e46b5cd11665ed4d039670ecb/.github/renovate.json#L8

[viceice]

I also use a custom regex versioning

https://github.com/visualon/renovate-config/blob/809f81d46a6c429e46b5cd11665ed4d039670ecb/shared.json#L144

[fmunteanu]

@viceice as discussed into #29635, it seems to be a general problem with the release notes not present, while using customDatasources. Should I open a bug report?

[viceice]

no, it's not a bug. it's current behavior. same happens on other datasources when not all versions are published.

so current behavior for changelogs.

1. determine platform from source url.
2. call platform specific change log function.
3. call getReleases with current dependency (uses current datasource)
4. use returned versions to calculate needed change logs (here we stop if there are missing versions)
5. fetch changelogs for each version in diff.

I would like to change step 3 to use the platform specific datasource instead ( eg github-tags for GitHub), so we've all required versions to calculate the diff.

@rarkins @secustor WDYT?

[rarkins]

I'm not sure I understand the proposed change fully. Do you have an example where the change is meaningful? A separate discussion would be better btw

[viceice]

your datasource doesn't return the current version, so renovate can't calculate the changes between.

that's why I use it only to set the allowed version for k3s inside the renovate config and use the GitHub releases datasource for normal k3s updates. see my posted repo links, all configs are there.

in my infra repo I simply have an env var inside a shell script.

[fmunteanu]

I misunderstood, I was under the impression you are experiencing the same issue, as I do. I'm not sure I understand what are the additional requirements. I added the packageRules, as detailed into your repo. Not sure what I'm missing, the configuration listed below does not add the release notes:

  "customDatasources": {
    "k3s": {
      "defaultRegistryUrlTemplate": "https://update.k3s.io/v1-release/channels",
      "transformTemplates": [
        "{\"releases\": [{\"version\": $$.(data[id = 'stable'].latest)}], \"homepage\": \"https://k3s.io/\", \"sourceUrl\": \"https://github.com/k3s-io/k3s\"}"
      ]
    }
  },
  "customManagers": [
    {
      "customType": "regex",
      "datasourceTemplate": "custom.k3s",
      "depNameTemplate": "k3s-io/k3s",
      "fileMatch": [
        "roles/k3s/defaults/main.yaml"
      ],
      "matchStrings": [
        "release:[\\s\\S]+k3s:[\\s\\S]+?version:\\s+(?<currentValue>.+)"
      ]
    }
  ],
  "packageRules": [
    {
      "matchDatasources": [
        "github-releases"
      ],
      "matchDepNames": [
        "k3s-io/k3s"
      ],
      "versioning": "regex:^v(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?<compatibility>\\+k3s)(?<build>\\d+)$"
    }
  ]

[viceice]

• Missing Changelogs / changelog version retrieval change #29687

[fmunteanu]

I'm going to re-open the discussion, since it not falls into #29687 scope, a changelog is present into each K3s release. I followed the official documentation and the release notes are not present into Renovate PR.

[viceice]

it's still same root cause. see my linked discussion

[fmunteanu]

@viceice Any updates on this improvement, Michael? Thank you.

[github-actions[bot]]

Hi there,

Please remember that there are no Service Level Agreements (SLAs) or roadmap commitments in Open Source projects like Renovate. The maintainers and contributors work on bugs/features/docs at their own pace. This means that sometimes you will have to wait for things to happen, or to get a response.

Please avoid comments like: "Any update on this?" or "When will this be fixed?". Do not chase a maintainer to get answers quickly. We will block you if you nudge us frequently.

Please read our Code of Conduct, how we prioritize work to learn more about how we prioritize what to work on. If you are a paying Mend.io customer, please tell your support or customer contact that this issue is important to you.

Thanks, the Renovate team