Configure when release notes are fetched, defaulting to latest/laziest

[HonkingGoose]

What would you like Renovate to be able to do?

Make it mandatory to configure which stage the notes are fetched at, defaulting to latest/laziest. ¹

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

Make fetchReleaseNotes an enum with values off, branch or pr. ²

renovate/lib/workers/repository/changelog/index.ts

Lines 25 to 37 in 0e47a10

	export function needsChangelogs(
	upgrade: BranchUpgradeConfig,
	fields = exposedConfigOptions.filter((o) => o !== 'commitBody')
	): boolean {
	// commitBody is now compiled when commit is done
	for (const field of fields) {
	// fields set by `getChangeLogJSON`
	if (containsTemplates(upgrade[field], ['logJSON', 'releases'])) {
	return true;
	}
	}
	return false;
	}

Called from here:

renovate/lib/workers/repository/updates/branchify.ts

Lines 75 to 89 in 0e47a10

	if (config.fetchReleaseNotes && config.repoIsOnboarded) {
	const branches = branchUpgrades[branchName].filter((upg) =>
	needsChangelogs(upg)
	);
	if (branches.length) {
	logger.warn(
	{
	branches: branches.map((b) => b.branchName),
	docs: 'https://docs.renovatebot.com/templates/',
	},
	'Fetching changelogs early is deprecated. Remove `logJSON` and `releases` from config templates. They are only allowed in `commitBody` template. See template docs for allowed templates'
	);
	await embedChangelogs(branches);
	}
	}

Is this a feature you are interested in implementing yourself?

No

Footnotes

1. https://github.com/renovatebot/renovate/discussions/20451#discussioncomment-4998357 ↩

2. https://github.com/renovatebot/renovate/discussions/20451#discussioncomment-4998368 ↩

[HonkingGoose]

Should this change go in a new major version of Renovate? The goal is to make it mandatory for users to decide when release notes are fetched, with a new default of latest/laziest.

[RahulGautamSingh]

To summarize:

The new config option will look like this:

  {
    name: 'fetchReleaseNotes',
    description: 'Controls if and during which stage release notes are fetched.',
    type: 'string',
    allowedValues: ['off', 'branch', 'pr'],
    default: 'pr',
    cli: false,
    env: false,
  },

And, after the new change we fetch release notes like this:

stage	condition
updates/branchify	if fetchReleaseNotes=off && needsChangelogs()=true
update/branch	if fetchReleaseNotes=branch OR config.commitBody && fetchReleaseNotes!=off && needsChangelogs()=true
update/pr	if fetchReleaseNotes=pr

[renovate-release]

🎉 This issue has been resolved in version 36.0.0 🎉

The release is available on:

• GitHub release
• 36.0.0

Your semantic-release bot 📦🚀