feat: add option to customise bot name (#90)

ahmadnassri · Oct 22, 2021 · 89c31b6 · 89c31b6
1 parent 0bd8bdd
commit 89c31b6
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -90,6 +90,7 @@ steps:
 | `config`       | ✔        | `.github/auto-merge.yml` | Path to configuration file *(relative to root)*     |
 | `target`       | ❌        | `patch`                  | The version comparison target (major, minor, patch) |
 | `command`      | ❌        | `merge`                  | The command to pass to Dependabot                   |
+| `botName`      | ❌        | `dependabot`             | The bot to tag in approve/comment message.          |
 | `approve`      | ❌        | `true`                   | Auto-approve pull-requests                          |
 
 ### Token Scope

diff --git a/action.yml b/action.yml
@@ -20,6 +20,11 @@ inputs:
     default: merge
     required: false
 
+  botName:
+    description: The bot to tag in approve/comment message. You can use this to create your own merge bot.
+    default: dependabot
+    required: false
+
   approve:
     description: Auto-approve pull-requests
     default: 'true'

diff --git a/action/index.js b/action/index.js
@@ -29,6 +29,7 @@ const inputs = {
   config: core.getInput('config', { required: false }),
   target: core.getInput('target', { required: false }),
   command: core.getInput('command', { required: false }),
+  botName: core.getInput('botName', { required: false }),
   approve: core.getInput('approve', { required: false })
 }
 

diff --git a/action/lib/index.js b/action/lib/index.js
@@ -26,7 +26,8 @@ export default async function (inputs) {
 
   if (proceed) {
     const command = inputs.approve === 'true' ? approve : comment
+    const botName = inputs.botName || 'dependabot'
 
-    await command(octokit, repo, pull_request, `@dependabot ${inputs.command}`)
+    await command(octokit, repo, pull_request, `@${botName} ${inputs.command}`)
   }
 }
diff --git a/docs/README.md b/docs/README.md
@@ -74,13 +74,14 @@ steps:
 
 ### Inputs
 
-| input          | required | default                   | description                                        |
-| -------------- | -------- | ------------------------- | -------------------------------------------------- |
+| input          | required | default                  | description                                         |
+|----------------|----------|--------------------------|-----------------------------------------------------|
 | `github-token` | ✔        | `github.token`           | The GitHub token used to merge the pull-request     |
-| `config`       | ✔        | `.github/auto-merge.yml` | Path to configuration file _(relative to root)_     |
-| `target`       | ❌       | `patch`                  | The version comparison target (major, minor, patch) |
-| `command`      | ❌       | `merge`                  | The command to pass to Dependabot                   |
-| `approve`      | ❌       | `true`                   | Auto-approve pull-requests                          |
+| `config`       | ✔        | `.github/auto-merge.yml` | Path to configuration file *(relative to root)*     |
+| `target`       | ❌        | `patch`                  | The version comparison target (major, minor, patch) |
+| `command`      | ❌        | `merge`                  | The command to pass to Dependabot                   |
+| `botName`      | ❌        | `dependabot`             | The bot to tag in approve/comment message.          |
+| `approve`      | ❌        | `true`                   | Auto-approve pull-requests                          |
 
 ### Token Scope