PR Enhancements

README.md

@@ -16,6 +16,8 @@ This Action is customizable so you can use it for your own purposes and it doesn
 | ---- | ----------- | ------- | -------- |
 | `github_token` | GitHub token to use for authentication within this Action | `${{ github.token }}` | `true` |
 | `branch_prefix` | Prefix for the branch name to use for the combined PR | `dependabot` | `true` |
+| `pr_title` | The title of the pull request to create | `Combined PRs` | `true` |
+| `pr_body_header` | The header of the pull request body | `# Combined PRs ➡️📦⬅️` | `true` |
 | `branch_regex` | The regex to match the branches to combine - more control than branch_prefix | `""` | `false` |
 | `ci_required` | Whether or not CI should be passing to combine the PR - can be `"true"` or `"false"`  | `"true"` | `true` |
 | `review_required` | Whether or not reviews should be passing to combine the PR - can be `"true"` or `"false"` | `"false"` | `false` |

__tests__/main.test.js

@@ -33,6 +33,8 @@ beforeEach(() => {
   jest.spyOn(core, 'error').mockImplementation(() => {})
   process.env.INPUT_GITHUB_TOKEN = 'faketoken'
   process.env.INPUT_CI_REQUIRED = 'true'
+  process.env.INPUT_PR_TITLE = 'Combined PRs'
+  process.env.INPUT_PR_BODY_HEADER = '# Combined PRs ➡️📦⬅️'
   process.env.INPUT_REVIEW_REQUIRED = 'false'
   process.env.INPUT_COMBINE_BRANCH_NAME = 'combined-prs-branch'
   process.env.INPUT_BRANCH_PREFIX = 'dependabot'
@@ -339,7 +341,7 @@ test('successfully runs the action', async () => {
   expect(infoMock).toHaveBeenCalledWith('Merged branch dependabot-5')
   expect(infoMock).toHaveBeenCalledWith('Creating combined PR')
   expect(debugMock).toHaveBeenCalledWith(
-    'PR body: ✅ This PR was created by the Combine PRs action by combining the following PRs:\n#1 Update dependency 1\n#5 Update dependency 5\n\n⚠️ The following PRs were left out due to merge conflicts:\n#2 Update dependency 2'
+    'PR body: # Combined PRs ➡️📦⬅️\n\n✅ The following pull requests have been successfully combined on this PR:\n- #1 Update dependency 1\n- #5 Update dependency 5\n\n⚠️ The following PRs were left out due to merge conflicts:\n- #2 Update dependency 2\n\n> This PR was created by the [`github/combine-prs`](https://github.com/github/combine-prs) action'
   )
   expect(infoMock).toHaveBeenCalledWith(
     'Combined PR created: https://github.com/test-owner/test-repo/pull/100'
@@ -408,7 +410,7 @@ test('successfully runs the action with the branch_regex option', async () => {
   expect(infoMock).toHaveBeenCalledWith('Merged branch dependabot-5')
   expect(infoMock).toHaveBeenCalledWith('Creating combined PR')
   expect(debugMock).toHaveBeenCalledWith(
-    'PR body: ✅ This PR was created by the Combine PRs action by combining the following PRs:\n#1 Update dependency 1\n#5 Update dependency 5\n\n⚠️ The following PRs were left out due to merge conflicts:\n#2 Update dependency 2'
+    'PR body: # Combined PRs ➡️📦⬅️\n\n✅ The following pull requests have been successfully combined on this PR:\n- #1 Update dependency 1\n- #5 Update dependency 5\n\n⚠️ The following PRs were left out due to merge conflicts:\n- #2 Update dependency 2\n\n> This PR was created by the [`github/combine-prs`](https://github.com/github/combine-prs) action'
   )
   expect(infoMock).toHaveBeenCalledWith(
     'Combined PR created: https://github.com/test-owner/test-repo/pull/100'

action.yml

@@ -13,6 +13,14 @@ inputs:
     description: The prefix of the branches to combine
     required: true
     default: dependabot
+  pr_title:
+    description: The title of the pull request to create
+    required: true
+    default: "Combined PRs"
+  pr_body_header:
+    description: The header of the pull request body
+    required: true
+    default: "# Combined PRs ➡️📦⬅️"
   branch_regex:
     description: The regex to match the branches to combine - more control than branch_prefix
     required: false

src/main.js

@@ -2,6 +2,9 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import {context} from '@actions/github'
 
+const repoName = 'github/combine-prs'
+const repoUrl = 'https://github.com/github/combine-prs'
+
 export async function run() {
   // Get configuration inputs
   const branchPrefix = core.getInput('branch_prefix')
@@ -11,6 +14,8 @@ export async function run() {
   const combineBranchName = core.getInput('combine_branch_name')
   const ignoreLabel = core.getInput('ignore_label')
   const token = core.getInput('github_token', {required: true})
+  const prTitle = core.getInput('pr_title', {required: true})
+  const prBodyHeader = core.getInput('pr_body_header', {required: true})
 
   // check for either prefix or regex
   if (branchPrefix === '' && branchRegex === '') {
@@ -175,23 +180,23 @@ export async function run() {
 
   // Create a new PR with the combined branch
   core.info('Creating combined PR')
-  const combinedPRsString = combinedPRs.join('\n')
-  let body =
-    '✅ This PR was created by the Combine PRs action by combining the following PRs:\n' +
-    combinedPRsString
+  const combinedPRsString = `- ${combinedPRs.join('\n- ')}`
+  let body = `${prBodyHeader}\n\n✅ The following pull requests have been successfully combined on this PR:\n${combinedPRsString}`
   if (mergeFailedPRs.length > 0) {
-    const mergeFailedPRsString = mergeFailedPRs.join('\n')
+    const mergeFailedPRsString = `- ${mergeFailedPRs.join('\n- ')}`
     body +=
       '\n\n⚠️ The following PRs were left out due to merge conflicts:\n' +
       mergeFailedPRsString
   }
 
+  body += `\n\n> This PR was created by the [\`${repoName}\`](${repoUrl}) action`
+
   core.debug('PR body: ' + body)
 
   const pullRequest = await octokit.rest.pulls.create({
     owner: context.repo.owner,
     repo: context.repo.repo,
-    title: 'Combined PR',
+    title: prTitle,
     head: combineBranchName,
     base: baseBranch,
     body: body