Skip to content

Commit

Permalink
chore: update notes on private channels
Browse files Browse the repository at this point in the history
  • Loading branch information
@lwhiteley
lwhiteley committed Sep 29, 2021
1 parent 7a700df commit 6a8092f
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Once the bot is setup, install the bot to your desired channel.

NB:

- For private channels, please additionally invite your bot user to the channel just as if you would invite any regular user.
- For private channels (or additional private channels), the bot (App) must be added to the channel

### Step 3: Create github secret

Expand Down Expand Up @@ -274,22 +274,22 @@ eg.

### Action Inputs

| Input | Modes | Description |
| -------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mode | \_\_\_ | Required input to tell the GH Action what mode to run. An invalid mode will fail the build. <br/><br/> **enum**: `INIT`, `CANCEL`, `MERGE`, `ALERT` <br/> **required:** `true` |
| channel | _ALL_ | The slack channel to use as the merge queue. Can specify channel id or name. Build will fail if the channel cannot be found <br/> **required:** `true` |
| team_id | _ALL_ | encoded [Slack team id](https://www.alphr.com/slack-find-team-id/) to list channels in, required if token belongs to org-wide app eg. `T1234567890` <br/> **default:** _undefined_ |
| icon_emoji | _ALL_ | A slack emoji to use as the bot's avatar <br/> **default:** `:robot_face:` |
| history_threshold | _ALL_ | The history threshold will stop looking up messages after the specified number of messages found do not in 'MERGING' messages <br/> **default:** `10` |
| channel_types | _ALL_ | Slack channel types to search through when trying to match the desired channel. <br/> **default:** `public_channel,private_channel` |
| init_trigger | INIT | The trigger text for adding a PR to the merge queue. <br/> **default:** `/merging` |
| cancel_trigger | CANCEL | The trigger text for cancelling a PR in the merge queue. <br/> **default:** `/cancel-merge` |
| cancel_ready_message | CANCEL | Message to be sent to the next PR in the queue after a cancel is complete <br/> **default:** `Previous PR merge was temporarily cancelled. This PR is now up for merge!` |
| merge_ready_message | MERGE | Message to be sent to the next PR in the queue after a merge/cancel occurs <br/> **default:** `Last PR closed. This PR is now up for merge!` |
| alert_message | ALERT | Message to be sent to the current PR in the queue <br/> **default:** `build is complete. Time to merge!` |
| only_when_current | ALERT | When `true`, will only send an alert to a PR in slack if it is currently up for merge. <br/> **enum:** `true`, `false` <br/> **default:** `true` |
| auto_notify | INIT | When `true`, will automatically notify any related github users to the pull request. <br/> **enum:** `true`, `false` <br/> **default:** `true` |
| delete_on_cancel | MERGE, CANCEL | When `true`, will delete a queue item when cancelled. <br/> **enum:** `true`, `false` <br/> **default:** `false` |
| Input | Modes | Description |
| -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mode | \_\_\_ | Required input to tell the GH Action what mode to run. An invalid mode will fail the build. <br/><br/> **enum**: `INIT`, `CANCEL`, `MERGE`, `ALERT` <br/> **required:** `true` |
| channel | _ALL_ | The slack channel to use as the merge queue. Can specify channel id or name. Build will fail if the channel cannot be found <br/> **required:** `true` |
| team_id | _ALL_ | encoded [Slack team id](https://www.alphr.com/slack-find-team-id/) to list channels in, required if token belongs to org-wide app eg. `T1234567890` <br/> **default:** _undefined_ |
| icon_emoji | _ALL_ | A slack emoji to use as the bot's avatar <br/> **default:** `:robot_face:` |
| history_threshold | _ALL_ | The history threshold will stop looking up messages after the specified number of messages found do not in 'MERGING' messages <br/> **default:** `10` |
| channel_types | _ALL_ | Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` <br/> **default:** `public_channel,private_channel` |
| init_trigger | INIT | The trigger text for adding a PR to the merge queue. <br/> **default:** `/merging` |
| cancel_trigger | CANCEL | The trigger text for cancelling a PR in the merge queue. <br/> **default:** `/cancel-merge` |
| cancel_ready_message | CANCEL | Message to be sent to the next PR in the queue after a cancel is complete <br/> **default:** `Previous PR merge was temporarily cancelled. This PR is now up for merge!` |
| merge_ready_message | MERGE | Message to be sent to the next PR in the queue after a merge/cancel occurs <br/> **default:** `Last PR closed. This PR is now up for merge!` |
| alert_message | ALERT | Message to be sent to the current PR in the queue <br/> **default:** `build is complete. Time to merge!` |
| only_when_current | ALERT | When `true`, will only send an alert to a PR in slack if it is currently up for merge. <br/> **enum:** `true`, `false` <br/> **default:** `true` |
| auto_notify | INIT | When `true`, will automatically notify any related github users to the pull request. <br/> **enum:** `true`, `false` <br/> **default:** `true` |
| delete_on_cancel | MERGE, CANCEL | When `true`, will delete a queue item when cancelled. <br/> **enum:** `true`, `false` <br/> **default:** `false` |

### Action Outputs

Expand Down

0 comments on commit 6a8092f

Please sign in to comment.