fix(template): allow prBodyDefinitions in templates (renovatebot#29893

)
bryannaegele · Jul 8, 2024 · 7f5939a · 7f5939a
1 parent 68d7388
commit 7f5939a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/lib/util/template/index.spec.ts b/lib/util/template/index.spec.ts
@@ -114,6 +114,22 @@ describe('util/template/index', () => {
     expect(output).toBe('CUSTOM_FOO is foo');
   });
 
+  it('and has access to prBodyDefinitions', () => {
+    const userTemplate =
+      'Issues: {{#each upgrades}}{{{prBodyDefinitions.Issue}}} {{/each}}';
+    const config = {
+      upgrades: [
+        {
+          prBodyDefinitions: {
+            Issue: '1234',
+          },
+        },
+      ],
+    };
+    const output = template.compile(userTemplate, config);
+    expect(output).toBe('Issues: 1234 ');
+  });
+
   it('replace', () => {
     const userTemplate =
       "{{ replace '[a-z]+\\.github\\.com' 'ghc' depName }}{{ replace 'some' 'other' depType }}";

diff --git a/lib/util/template/index.ts b/lib/util/template/index.ts
@@ -207,6 +207,11 @@ const compileInputProxyHandler: ProxyHandler<CompileInput> = {
 
     const value = target[prop];
 
+    if (prop === 'prBodyDefinitions') {
+      // Expose all prBodyDefinitions.*
+      return value;
+    }
+
     if (is.array(value)) {
       return value.map((element) =>
         is.primitive(element)
@@ -248,6 +253,10 @@ export function compile(
         continue;
       }
       for (const varName of varNames) {
+        if (varName === 'prBodyDefinitions') {
+          // Allow all prBodyDefinitions.*
+          break;
+        }
         if (!allowedFieldsList.includes(varName)) {
           logger.info(
             { varName, template },