Skip to content

Commit 4eef476

Browse files
committed
fix(stale): document the permission the upstream cache needs
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
1 parent 536745d commit 4eef476

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

‎actions/stale/README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,19 @@ jobs:
2323
runs-on: ubuntu-latest
2424
timeout-minutes: 10
2525
permissions:
26+
actions: write
2627
issues: write
2728
pull-requests: write
2829
steps:
2930
- uses: TrogonStack/github-actions/actions/stale@<sha> # vX.Y.Z
3031
```
3132
33+
`actions: write` is not optional. Upstream keeps its progress in the Actions
34+
cache so a run capped by `operations-per-run` resumes where the last one
35+
stopped, and managing that cache entry needs the permission. Without it the
36+
cache delete fails with a 403, every run replays the same prefix of the
37+
backlog, and anything past that prefix is never closed.
38+
3239
Run it once with `debug-only: true` before pointing it at a repository with
3340
years of backlog, so the first real run is not a surprise.
3441

@@ -52,9 +59,9 @@ remove.
5259
| --- | --- | --- |
5360
| `days-before-stale` | `60` | Days without activity before marking stale. |
5461
| `days-before-close` | `7` | Days after marking before closing. `-1` marks but never closes. |
55-
| `operations-per-run` | `100` | API operations budget for one run. |
62+
| `operations-per-run` | `100` | API operations budget for one run. A run that hits the cap resumes from where it stopped. |
5663
| `debug-only` | `false` | Report what would happen and change nothing. |
57-
| `token` | `github.token` | Needs write access to issues and pull requests. |
64+
| `token` | `github.token` | Needs write access to actions, issues, and pull requests. |
5865

5966
## Fixed behaviour
6067

0 commit comments

Comments
 (0)