Trying to understand changelog retrieval inconsistencies #29943
-
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.n/a Please tell us more about your question or problemHi, I have a Helm chart with some example dependencies I've collected to demonstrate some observed inconsistencies in how changelogs are displayed in Renovate PRs. My main goal is to know how to help Renovate consistently generate a changelog specifically from The reproduction repo is here: Please note that the Renovate configuration is basic, and the Chart in question has comments for each dependency describing the various behaviors observed in their corresponding pull requests. My questions:
You can Any insight you might have would be greatly appreciated—thanks! Related:
Logs (if relevant)Log snippet |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 5 replies
-
Not sure if you were trying to be sarcastic with this, but this is not what we are after. Currently what you wrote is like saying "Expected behavior is that it works, observed behavior is that it doesn't". Instead it's intended that it include something like |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for your quick response! 🙏 Sarcasm was not my intention; I thought the discussion thread was the primary source for such details, but I've just discovered the guidelines for minimal reproductions and have updated the repo README accordingly (and updated the discussion template in #29949). I appreciate the clarification and look forward to hearing your insights. 🙂 |
Beta Was this translation helpful? Give feedback.
-
|
Gentle bump to check if anything's still missing from the reproduction? FYI, I've updated both the question and the repo for clarity since my previous comment. Thanks again! |
Beta Was this translation helpful? Give feedback.
-
|
There's at least two separate problems you identified:
I could not fix either quickly so created issues #30297 and #30298 for these |
Beta Was this translation helpful? Give feedback.
-
|
Thank you! I will check and see if I can contribute a PR for at least one of these. |
Beta Was this translation helpful? Give feedback.
-
|
FYI I tried to make the changes myself, but it didn't seem to fix anything, so I must still be missing something. Here was my attempt in case it helps: diff --git a/lib/workers/repository/update/pr/changelog/source.ts b/lib/workers/repository/update/pr/changelog/source.ts
index 71a9f65ca..6eb90cd3b 100644
--- a/lib/workers/repository/update/pr/changelog/source.ts
+++ b/lib/workers/repository/update/pr/changelog/source.ts
@@ -74,6 +74,7 @@ export abstract class ChangeLogSource {
const newVersion = config.newVersion!;
const sourceUrl = config.sourceUrl!;
const packageName = config.packageName!;
+ const depName = config.depName!;
const sourceDirectory = config.sourceDirectory;
const version = allVersioning.get(versioning);
@@ -143,8 +144,8 @@ export abstract class ChangeLogSource {
compare: {},
};
const tags = await getTags();
- const prevHead = this.getRef(version, packageName, prev, tags);
- const nextHead = this.getRef(version, packageName, next, tags);
+ const prevHead = this.getRef(version, packageName, depName, prev, tags);
+ const nextHead = this.getRef(version, packageName, depName, next, tags);
if (is.nonEmptyString(prevHead) && is.nonEmptyString(nextHead)) {
release.compare.url = this.getCompareURL(
baseUrl,
@@ -184,12 +185,13 @@ export abstract class ChangeLogSource {
private findTagOfRelease(
version: allVersioning.VersioningApi,
+ depName: string,
packageName: string,
depNewVersion: string,
tags: string[],
): string | undefined {
- const regex = regEx(`(?:${packageName}|release)[@-]`, undefined, false);
- const exactReleaseRegex = regEx(`${packageName}[@\\-_]v?${depNewVersion}`);
+ const regex = regEx(`(?:${depName}|${packageName}|release)[@-]`, undefined, false);
+ const exactReleaseRegex = regEx(`(?:${depName}|${packageName})[@\\-_]v?${depNewVersion}`);
const exactTagsList = tags.filter((tag) => {
return exactReleaseRegex.test(tag);
});
@@ -202,12 +204,14 @@ export abstract class ChangeLogSource {
private getRef(
version: allVersioning.VersioningApi,
packageName: string,
+ depName: string,
release: Release,
tags: string[],
): string | null {
const tagName = this.findTagOfRelease(
version,
packageName,
+ depName,
release.version,
tags,
); |
Beta Was this translation helpful? Give feedback.
There's at least two separate problems you identified:
I could not fix either quickly so created issues #30297 and #30298 for these