Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade Docs, better error reporting #18

Merged
merged 9 commits into from
Jun 22, 2020
Merged

Upgrade Docs, better error reporting #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
15834d4
Upgrade dependencies
Jun 22, 2020
d9ce225
Document required OAuth scopes
Jun 22, 2020
3deaed7
Add note about exhausting rate limit
Jun 22, 2020
3ade6fa
Supply the entire error message to output
Jun 22, 2020
b47a85e
Build with intentional bug
Jun 22, 2020
ff0bd55
Build the bug
Jun 22, 2020
aaefcf8
Build with actual bug
Jun 22, 2020
7f1b521
Fix bug
Jun 22, 2020
76bedae
Update changelog
Jun 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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).
Loading