Merge pull request #18 from voxmedia/jl-doc-upgrades

Upgrade Docs, better error reporting

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v1.1.2 - 6/22/2020
+
+- Describes which OAuth scopes are required in the docs.
+- Prints out the entire Error object instead of just the message, for better debugging purposes (e.g. additional OAuth scopes needed).
+- Adds note to docs about rate limiting concerns
+
 # v1.1.1 - 2/3/2020
 
 - Fixes bug where owner/repo can not be determined with certain events (like scheduled jobs)

README.md

@@ -97,6 +97,8 @@ You can use the `success()` and `failure()` conditional checks within your workf
 
 The name of the channel to post the message to. **Required** if no `channel_id` is provided.
 
+_Note_: If your workspace has many channels, supplying only a `channel` may cause rate limiting issues with this GitHub Action. Consider supplying a `channel_id` instead.
+
 ### `channel_id`
 
 The ID of the channel to post the message to. **Required** if no `channel` is provided, or if you need to send to a DM.
@@ -130,6 +132,16 @@ To use this GitHub Action, you'll need a [Slack bot token](https://api.slack.com
 1. **Set an icon for your bot.** Browse to the "Basic information" page listed in the sidebar. Scroll down to the section titled "Display information" to set an icon.
 1. **Install your app to your workspace.** At the top of the "Basic information" page, you can find a section titled "Install your app to your workspace". Click on it, then use the button to complete the installation.
 
+### Slack App OAuth Scopes
+
+In order to use your Slack App with this GitHub Action, be sure to enable the following OAuth scopes:
+
+| Scope           | Required?                                  |
+| --------------- | ------------------------------------------ |
+| `chat:write`    | Yes                                        |
+| `channels:read` | If using `channel` instead of `channel_id` |
+| `groups:read`   | If using `channel` instead of `channel_id` |
+
 ## License
 
 The scripts and documentation in this project are released under the [Apache 2.0 License](LICENSE).