From 6a8092f446adc262ef4c9f1479490b00806c93bf Mon Sep 17 00:00:00 2001 From: Layton Whiteley Date: Wed, 29 Sep 2021 04:29:02 +0200 Subject: [PATCH] chore: update notes on private channels --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 678e041d..250975b9 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.

**enum**: `INIT`, `CANCEL`, `MERGE`, `ALERT`
**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
**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`
**default:** _undefined_ | -| icon_emoji | _ALL_ | A slack emoji to use as the bot's avatar
**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
**default:** `10` | -| channel_types | _ALL_ | Slack channel types to search through when trying to match the desired channel.
**default:** `public_channel,private_channel` | -| init_trigger | INIT | The trigger text for adding a PR to the merge queue.
**default:** `/merging` | -| cancel_trigger | CANCEL | The trigger text for cancelling a PR in the merge queue.
**default:** `/cancel-merge` | -| cancel_ready_message | CANCEL | Message to be sent to the next PR in the queue after a cancel is complete
**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
**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
**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.
**enum:** `true`, `false`
**default:** `true` | -| auto_notify | INIT | When `true`, will automatically notify any related github users to the pull request.
**enum:** `true`, `false`
**default:** `true` | -| delete_on_cancel | MERGE, CANCEL | When `true`, will delete a queue item when cancelled.
**enum:** `true`, `false`
**default:** `false` | +| Input | Modes | Description | +| -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| mode | \_\_\_ | Required input to tell the GH Action what mode to run. An invalid mode will fail the build.

**enum**: `INIT`, `CANCEL`, `MERGE`, `ALERT`
**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
**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`
**default:** _undefined_ | +| icon_emoji | _ALL_ | A slack emoji to use as the bot's avatar
**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
**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`
**default:** `public_channel,private_channel` | +| init_trigger | INIT | The trigger text for adding a PR to the merge queue.
**default:** `/merging` | +| cancel_trigger | CANCEL | The trigger text for cancelling a PR in the merge queue.
**default:** `/cancel-merge` | +| cancel_ready_message | CANCEL | Message to be sent to the next PR in the queue after a cancel is complete
**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
**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
**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.
**enum:** `true`, `false`
**default:** `true` | +| auto_notify | INIT | When `true`, will automatically notify any related github users to the pull request.
**enum:** `true`, `false`
**default:** `true` | +| delete_on_cancel | MERGE, CANCEL | When `true`, will delete a queue item when cancelled.
**enum:** `true`, `false`
**default:** `false` | ### Action Outputs