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

Update README about required permissions #10

Merged
merged 1 commit into from
Apr 22, 2023
Merged

Update README about required permissions #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Use this action to trigger events such as notifications or alerts at the end of

* `status` - Returns either `success`, `cancelled` or `failure`.

### Required permissions
```yaml
permissions:
actions: read
```

### Example usage

Simply add a job to the end of your workflow and list the last job as dependency using `needs`. Then add a step within that job including a condition to trigger an event like a Slack notification or similar.
Expand Down Expand Up @@ -42,6 +48,9 @@ on:
branches:
- master

permissions:
actions: read

jobs:

test:
Expand Down