Skip to content

Commit

Permalink
Update documentation for opened-only usage
Browse files Browse the repository at this point in the history
  • Loading branch information
pbrisbin committed Oct 4, 2024
1 parent 4adaa10 commit ea272b6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 13 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,26 +52,14 @@ on:
- cron: "0 0 * * *"
pull_request:
types: [opened]
```

Mergeabot knows if it's running on a `pull_request` event in a Dependabot PR
and, if so, leaves a comment on the PR indicating, roughly, "I got this."

![Mergeabot comment on opened event](./screenshots/opened-comment.png)

When configured this way, Mergeabot will run when the PR is opened or updated,
so it can let you know that the updates have reset the clock on the quarantine:

![Mergeabot comment on synchronized event](./screenshots/synchronized-comment.png)

If you don't prefer this, just limit it to only `opened` events:

```yaml
on:
pull_request:
types: [opened]
```

## Permissions

Dependabot PRs use a token with read-only permissions by default, so you'll need
Expand All @@ -98,6 +86,7 @@ on:
- cron: "0 0 * * *"
pull_request:
types: [opened]
permissions:
contents: write
Expand Down
Binary file removed screenshots/synchronized-comment.png
Binary file not shown.

0 comments on commit ea272b6

Please sign in to comment.