feat(util/template): add prettyVersion field

docs/usage/configuration-options.md

@@ -2138,6 +2138,22 @@ Here's an example of how you would define PR priority so that devDependencies ar
 
 The PR title is important for some of Renovate's matching algorithms (e.g. determining whether to recreate a PR or not) so ideally don't modify it much.
 
+## prettyNewMajor
+
+This option allows editing `newMajor` value by templating, it is defaulted to prepend `v` to the `newMajor` value.
+
+For example, to create a PR title with the changed version:
+
+`{ "commitMessageExtra": "{{prettyNewMajor}}" }`
+
+## prettyVersion
+
+This option allows editing `newVersion` value by templating, it is defaulted to prepend `v` to the `newVersion` value.
+
+For example, to create a PR title with the changed version:
+
+`{ "commitMessageExtra": "{{prettyNewVersion}}" }`
+
 ## printConfig
 
 This option is useful for troubleshooting, particularly if using presets.

docs/usage/templates.md

@@ -83,3 +83,10 @@ In the example above, it will only show a text if `isMajor=true` and `hasRelease
 Returns `true` if at least one expression is `true`.
 
 `{{#if (or isPatch isSingleVersion}}Small update, safer to merge and release.{{else}}Check out the changelog for all versions before merging!{{/if}}`
+
+## prettifyVersion
+
+Prepends `v` to start of `newMajor` or `newVersion` or any string not starting with `v`.
+For example, to create a PR title with the changed version:
+
+`{ "commitMessageExtra": "{{prettifyVersion newVersion}}" }`

lib/config/options/index.ts

@@ -1633,6 +1633,20 @@ const options: RenovateOptions[] = [
     default: 'dependency {{depName}}',
     cli: false,
   },
+  {
+    name: 'prettyVersion',
+    description: 'the new version value with v prepended to it.',
+    type: 'string',
+    default: '{{prettifyVersion newVersion}}',
+    cli: false,
+  },
+  {
+    name: 'prettyNewMajor',
+    description: 'The new major value with v prepended to it',
+    type: 'string',
+    default: '{{prettifyVersion newMajor}}',
+    cli: false,
+  },
   {
     name: 'commitMessageExtra',
     description:

lib/util/template/index.spec.ts

@@ -80,4 +80,25 @@ describe('util/template/index', () => {
     const output = template.compile(userTemplate, undefined as never);
     expect(output).toBe('foo');
   });
+
+  it('does not append v to version when present', () => {
+    const userTemplate = '{{{prettifyVersion newVersion}}}';
+    const input = { newVersion: 'v5.1.2' };
+    const output = template.compile(userTemplate, input);
+    expect(output).toBe('v5.1.2');
+  });
+
+  it('appends v to version when present', () => {
+    const userTemplate = '{{{prettifyVersion newVersion}}}';
+    const input = { newVersion: '5.1.2' };
+    const output = template.compile(userTemplate, input);
+    expect(output).toBe('v5.1.2');
+  });
+
+  it('appends v to newMajor', () => {
+    const userTemplate = '{{{prettifyVersion newMajor}}}';
+    const input = { newMajor: 5 };
+    const output = template.compile(userTemplate, input);
+    expect(output).toBe('v5');
+  });
 });

lib/util/template/index.ts

@@ -23,6 +23,13 @@ handlebars.registerHelper('containsString', (str, subStr) =>
   str?.includes(subStr)
 );
 
+handlebars.registerHelper('prettifyVersion', (version: string | number) => {
+  if (is.string(version) && version.charAt(0) === 'v') {
+    return version;
+  }
+  return `v${version}`;
+});
+
 handlebars.registerHelper({
   and(...args) {
     // Need to remove the 'options', as last parameter
@@ -59,6 +66,8 @@ export const exposedConfigOptions = [
   'prBodyDefinitions',
   'prBodyNotes',
   'prTitle',
+  'prettyVersion',
+  'prettyNewMajor',
   'semanticCommitScope',
   'semanticCommitType',
   'separateMajorMinor',

lib/workers/repository/updates/generate.spec.ts

@@ -564,6 +564,50 @@ describe('workers/repository/updates/generate', () => {
       );
     });
 
+    it('use pretty new version in pr title', () => {
+      const branch: BranchUpgradeConfig[] = [
+        {
+          ...defaultConfig,
+          manager: 'some-manager',
+          depName: 'some-dep',
+          packageFile: 'foo/bar/package.json',
+          packageFileDir: 'foo/bar',
+          semanticCommits: 'enabled',
+          semanticCommitType: 'chore',
+          semanticCommitScope: '{{packageFileDir}}',
+          commitMessageExtra: '{{prettyVersion}}',
+          newValue: '1.2.0',
+          isSingleVersion: true,
+          newVersion: 'v1.2.0',
+        } as BranchUpgradeConfig,
+      ];
+      const res = generateBranchConfig(branch);
+      expect(res.prTitle).toBe(
+        'chore(foo/bar): update dependency some-dep v1.2.0'
+      );
+    });
+
+    it('use pretty new major in pr title', () => {
+      const branch: BranchUpgradeConfig[] = [
+        {
+          ...defaultConfig,
+          manager: 'some-manager',
+          depName: 'some-dep',
+          packageFile: 'foo/bar/package.json',
+          packageFileDir: 'foo/bar',
+          semanticCommits: 'enabled',
+          semanticCommitType: 'chore',
+          semanticCommitScope: '{{packageFileDir}}',
+          commitMessageExtra: '{{prettyNewMajor}}',
+          newValue: '3.2.0',
+          newVersion: 'v3.2.0',
+          newMajor: 3,
+        } as BranchUpgradeConfig,
+      ];
+      const res = generateBranchConfig(branch);
+      expect(res.prTitle).toBe('chore(foo/bar): update dependency some-dep v3');
+    });
+
     it('adds commit message body', () => {
       // TODO #7154 incompatible types
       const branch: BranchUpgradeConfig[] = [