Add 'pr-message-template' input to allow setting custom PR message (gradle-update#886)

* Add 'pr-message-template' input to allow setting custom PR message

Allow setting custom PR message.

Fixes gradle-update#495

* update README

* refactor messages

Author: cristiangreco

README.md

@@ -32,6 +32,7 @@ Request](https://user-images.githubusercontent.com/316923/93274006-8922ef80-f7b9
   - [`release-channel`](#release-channel)
   - [`merge-method`](#merge-method)
   - [`pr-title-template`](#pr-title-template)
+  - [`pr-message-template`](#pr-message-template)
   - [`commit-message-template`](#commit-message-template)
 - [Examples](#examples)
   - [Scheduling action execution](#scheduling-action-execution)
@@ -144,8 +145,12 @@ This is the list of supported inputs:
 | [`paths`](#paths) | List of paths where to search for Gradle Wrapper files (comma or newline-separated). | No | (empty) |
 | [`paths-ignore`](#paths-ignore) | List of paths to be excluded when searching for Gradle Wrapper files (comma or newline-separated). | No | (empty) |
 | [`set-distribution-checksum`](#set-distribution-checksum) | Whether to set the `distributionSha256Sum` property. | No | `true` |
+| [`distributions-base-url`](#distributions-base-url) | Set a custom url to download the Gradle Wrapper zip file from. | No | (empty) |
 | [`release-channel`](#release-channel) | Which Gradle release channel to use: either `stable` or `release-candidate`. | No | `stable` |
 | [`merge-method`](#merge-method) | Which merge method to use for [auto-merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request). Valid values include `MERGE`, `REBASE`, or `SQUASH`.  If unset, automerge will not be enabled on opened PRs. | No | (unset) No auto-merge |
+| [`pr-title-template`](#pr-title-template) | The template to use for the title of the pull request created by this action | No | `Update Gradle Wrapper from %sourceVersion% to %targetVersion%` |
+| [`pr-message-template`](#pr-message-template) | The template to use for the description of the pull request created by this action | No | (empty) |
+| [`commit-message-template`](#commit-message-template) | The template to use for the commit message created by this action | No | `Update Gradle Wrapper from %sourceVersion% to %targetVersion%` |
 
 ---
 
@@ -429,6 +434,9 @@ For example:
 with:
   release-channel: release-candidate
 ```
+
+---
+
 ### `merge-method`
 
 | Name | Description | Required | Default |
@@ -443,6 +451,9 @@ For example:
 with:
   merge-method: SQUASH
 ```
+
+---
+
 ### `pr-title-template`
 
 | Name | Description | Required | Default |
@@ -462,6 +473,29 @@ with:
   pr-title-template: 'chore(deps): Bump Gradle Wrapper from %sourceVersion% to %targetVersion%'
 ```
 
+---
+
+### `pr-message-template`
+
+| Name | Description | Required | Default |
+| --- | --- | --- | --- |
+| `pr-message-template` | The template to use for the description of the pull request created by this action | No | (empty) |
+
+This input is used for the description of the pull request created by this action.
+
+`%sourceVersion%` and `%targetVersion%` will be replaced by the current/old and the new version of the Gradle Wrapper respectively.
+
+There are cases in which the source version of the Gradle Wrapper can not be determined successfully. In such cases, the string `undefined` will be used to replace the source version placeholder.
+
+For example:
+
+```yaml
+with:
+  pr-message-template: 'Upgrading the Gradle Wrapper from version %sourceVersion% to %targetVersion%.'
+```
+
+---
+
 ### `commit-message-template`
 
 | Name | Description | Required | Default |

action.yml

@@ -54,15 +54,26 @@ inputs:
     required: false
   pr-title-template:
     description: |
-      Template used for PR title.
+      Template used for PR title. Use %sourceVersion% and %targetVersion% to
+      refer to the source and target versions of the Gradle Wrapper.
       There are cases in which the source version of the Gradle Wrapper can not
       be determined successfully. In such cases, the string 'undefined' will be
       used to replace the source version placeholder.
     required: false
     default: 'Update Gradle Wrapper from %sourceVersion% to %targetVersion%'
+  pr-message-template:
+    description: |
+      Template used for PR description. Use %sourceVersion% and %targetVersion%
+      to refer to the source and target versions of the Gradle Wrapper.
+      There are cases in which the source version of the Gradle Wrapper can not
+      be determined successfully. In such cases, the string 'undefined' will be
+      used to replace the source version placeholder.
+    required: false
+    default: ''
   commit-message-template:
     description: |
-      Template used for commit message.
+      Template used for commit message. Use %sourceVersion% and %targetVersion%
+      to refer to the source and target versions of the Gradle Wrapper.
       There are cases in which the source version of the Gradle Wrapper can not
       be determined successfully. In such cases, the string 'undefined' will be
       used to replace the source version placeholder.

dist/index.js

@@ -727,13 +727,20 @@ class GitHubOps {
             return;
         });
     }
-    createPullRequest(branchName, prTitleTemplate, distTypes, targetRelease, sourceVersion) {
+    createPullRequest(branchName, distTypes, targetRelease, sourceVersion) {
         return __awaiter(this, void 0, void 0, function* () {
             const targetBranch = this.inputs.targetBranch !== ''
                 ? this.inputs.targetBranch
                 : yield this.api.repoDefaultBranch();
             core.debug(`Target branch: ${targetBranch}`);
-            const { title, body } = (0, messages_1.pullRequestText)(prTitleTemplate, distTypes, targetRelease, sourceVersion);
+            let title, body;
+            if (this.inputs.prMessageTemplate) {
+                title = (0, messages_1.replaceVersionPlaceholders)(this.inputs.prTitleTemplate, sourceVersion, targetRelease.version);
+                body = (0, messages_1.replaceVersionPlaceholders)(this.inputs.prMessageTemplate, sourceVersion, targetRelease.version);
+            }
+            else {
+                ({ title, body } = (0, messages_1.pullRequestText)(this.inputs.prTitleTemplate, distTypes, targetRelease, sourceVersion));
+            }
             const pullRequest = yield this.api.createPullRequest({
                 branchName: `refs/heads/${branchName}`,
                 target: targetBranch,
@@ -931,6 +938,12 @@ class ActionInputs {
             this.prTitleTemplate =
                 'Update Gradle Wrapper from %sourceVersion% to %targetVersion%';
         }
+        this.prMessageTemplate = core
+            .getInput('pr-message-template', { required: false })
+            .trim();
+        if (!this.prMessageTemplate) {
+            this.prMessageTemplate = '';
+        }
         this.commitMessageTemplate = core
             .getInput('commit-message-template', { required: false })
             .trim();
@@ -950,25 +963,19 @@ class ActionInputs {
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.pullRequestTitle = pullRequestTitle;
-exports.commitMessageText = commitMessageText;
+exports.replaceVersionPlaceholders = replaceVersionPlaceholders;
 exports.pullRequestText = pullRequestText;
 const ISSUES_URL = 'https://github.com/gradle-update/update-gradle-wrapper-action/issues';
 const TARGET_VERSION_PLACEHOLDER = '%targetVersion%';
 const SOURCE_VERSION_PLACEHOLDER = '%sourceVersion%';
-function pullRequestTitle(template, sourceVersion, targetVersion) {
+function replaceVersionPlaceholders(template, sourceVersion, targetVersion) {
     return template
         .replace(TARGET_VERSION_PLACEHOLDER, targetVersion)
         .replace(SOURCE_VERSION_PLACEHOLDER, sourceVersion !== null && sourceVersion !== void 0 ? sourceVersion : 'undefined');
 }
-function commitMessageText(template, source, target) {
-    return template
-        .replace(TARGET_VERSION_PLACEHOLDER, target)
-        .replace(SOURCE_VERSION_PLACEHOLDER, source ? source : 'undefined');
-}
 function pullRequestText(prTitleTemplate, distTypes, targetRelease, sourceVersion) {
     const targetVersion = targetRelease.version;
-    const title = pullRequestTitle(prTitleTemplate, sourceVersion, targetVersion);
+    const title = replaceVersionPlaceholders(prTitleTemplate, sourceVersion, targetVersion);
     const bodyHeader = `${title}.
 
 Read the release notes: https://docs.gradle.org/${targetVersion}/release-notes.html`;
@@ -1323,7 +1330,7 @@ class MainAction {
                         yield updater.verify();
                         core.endGroup();
                         core.startGroup('Committing');
-                        const commitMessage = (0, messages_1.commitMessageText)(this.inputs.commitMessageTemplate, wrapper.version, targetRelease.version);
+                        const commitMessage = (0, messages_1.replaceVersionPlaceholders)(this.inputs.commitMessageTemplate, wrapper.version, targetRelease.version);
                         yield (0, git_commit_1.commit)(modifiedFiles, commitMessage);
                         core.endGroup();
                         commitDataList.push({
@@ -1348,7 +1355,7 @@ class MainAction {
                 core.info('Pushing branch');
                 yield git.push(branchName);
                 core.info('Creating Pull Request');
-                const pullRequestData = yield this.githubOps.createPullRequest(branchName, this.inputs.prTitleTemplate, distTypes, targetRelease, commitDataList.length === 1
+                const pullRequestData = yield this.githubOps.createPullRequest(branchName, distTypes, targetRelease, commitDataList.length === 1
                     ? commitDataList[0].sourceVersion
                     : undefined);
                 core.info(`✅ Created a Pull Request at ${pullRequestData.url} ✨`);

src/github/gh-ops.ts

@@ -19,7 +19,7 @@ import {context, getOctokit} from '@actions/github';
 
 import {Inputs} from '../inputs';
 import {PullRequestData} from '../store';
-import {pullRequestText} from '../messages';
+import {replaceVersionPlaceholders, pullRequestText} from '../messages';
 import {Release} from '../releases';
 import {GitHubApi, IGitHubApi} from './gh-api';
 
@@ -61,7 +61,6 @@ export class GitHubOps {
 
   async createPullRequest(
     branchName: string,
-    prTitleTemplate: string,
     distTypes: Set<string>,
     targetRelease: Release,
     sourceVersion?: string
@@ -73,12 +72,27 @@ export class GitHubOps {
 
     core.debug(`Target branch: ${targetBranch}`);
 
-    const {title, body} = pullRequestText(
-      prTitleTemplate,
-      distTypes,
-      targetRelease,
-      sourceVersion
-    );
+    let title, body;
+
+    if (this.inputs.prMessageTemplate) {
+      title = replaceVersionPlaceholders(
+        this.inputs.prTitleTemplate,
+        sourceVersion,
+        targetRelease.version
+      );
+      body = replaceVersionPlaceholders(
+        this.inputs.prMessageTemplate,
+        sourceVersion,
+        targetRelease.version
+      );
+    } else {
+      ({title, body} = pullRequestText(
+        this.inputs.prTitleTemplate,
+        distTypes,
+        targetRelease,
+        sourceVersion
+      ));
+    }
 
     const pullRequest = await this.api.createPullRequest({
       branchName: `refs/heads/${branchName}`,

src/inputs/index.ts

@@ -28,6 +28,7 @@ export interface Inputs {
   releaseChannel: string;
   mergeMethod: string | undefined;
   prTitleTemplate: string;
+  prMessageTemplate: string;
   commitMessageTemplate: string;
 }
 
@@ -51,6 +52,7 @@ class ActionInputs implements Inputs {
   releaseChannel: string;
   mergeMethod: string | undefined;
   prTitleTemplate: string;
+  prMessageTemplate: string;
   commitMessageTemplate: string;
 
   constructor() {
@@ -127,6 +129,13 @@ class ActionInputs implements Inputs {
         'Update Gradle Wrapper from %sourceVersion% to %targetVersion%';
     }
 
+    this.prMessageTemplate = core
+      .getInput('pr-message-template', {required: false})
+      .trim();
+    if (!this.prMessageTemplate) {
+      this.prMessageTemplate = '';
+    }
+
     this.commitMessageTemplate = core
       .getInput('commit-message-template', {required: false})
       .trim();

src/messages.ts

@@ -20,34 +20,28 @@ const ISSUES_URL =
 const TARGET_VERSION_PLACEHOLDER = '%targetVersion%';
 const SOURCE_VERSION_PLACEHOLDER = '%sourceVersion%';
 
-export function pullRequestTitle(
+export function replaceVersionPlaceholders(
   template: string,
   sourceVersion: string | undefined,
   targetVersion: string
-) {
+): string {
   return template
     .replace(TARGET_VERSION_PLACEHOLDER, targetVersion)
     .replace(SOURCE_VERSION_PLACEHOLDER, sourceVersion ?? 'undefined');
 }
 
-export function commitMessageText(
-  template: string,
-  source: string | undefined,
-  target: string
-): string {
-  return template
-    .replace(TARGET_VERSION_PLACEHOLDER, target)
-    .replace(SOURCE_VERSION_PLACEHOLDER, source ? source : 'undefined');
-}
-
 export function pullRequestText(
   prTitleTemplate: string,
   distTypes: Set<string>,
   targetRelease: Release,
   sourceVersion?: string
 ): {title: string; body: string} {
   const targetVersion = targetRelease.version;
-  const title = pullRequestTitle(prTitleTemplate, sourceVersion, targetVersion);
+  const title = replaceVersionPlaceholders(
+    prTitleTemplate,
+    sourceVersion,
+    targetVersion
+  );
   const bodyHeader = `${title}.
 
 Read the release notes: https://docs.gradle.org/${targetVersion}/release-notes.html`;

src/tasks/main.ts

@@ -19,7 +19,7 @@ import * as gitAuth from '../git/git-auth';
 import * as store from '../store';
 
 import {commit} from '../git/git-commit';
-import {commitMessageText} from '../messages';
+import {replaceVersionPlaceholders} from '../messages';
 import {createWrapperInfo} from '../wrapperInfo';
 import {createWrapperUpdater} from '../wrapperUpdater';
 import {findWrapperPropertiesFiles} from '../wrapper/find';
@@ -162,7 +162,7 @@ export class MainAction {
 
           core.startGroup('Committing');
 
-          const commitMessage = commitMessageText(
+          const commitMessage = replaceVersionPlaceholders(
             this.inputs.commitMessageTemplate,
             wrapper.version,
             targetRelease.version
@@ -202,7 +202,6 @@ export class MainAction {
       core.info('Creating Pull Request');
       const pullRequestData = await this.githubOps.createPullRequest(
         branchName,
-        this.inputs.prTitleTemplate,
         distTypes,
         targetRelease,
         commitDataList.length === 1