Skip to content

Commit

Permalink
Merge pull request #41 from houjunchen/permission
Browse files Browse the repository at this point in the history
Update readme about permission
  • Loading branch information
AnthonyKinson committed Oct 19, 2022
2 parents 26981ee + f1fbacb commit 60bbfbb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This action will post workflow status notifications into your Slack channel. The
## Usage
To use this action properly, you should create a new `job` at the end of your workflow that `needs` all other jobs in the workflow. This ensures that this action is only run once all jobs in your workflow are complete.

This action requires `read` permission of `actions` scope. You should assign a job level `actions` permission if workflow level `actions` permission is set `none`.

```yaml
name: World Greeter
on:
Expand All @@ -43,6 +45,9 @@ jobs:
- job-1
- job-2
runs-on: ubuntu-latest
# actions.read permission is required.
permissions:
actions: 'read'
steps:
- name: Slack Workflow Notification
uses: Gamesight/slack-workflow-status@master
Expand Down

0 comments on commit 60bbfbb

Please sign in to comment.