Skip to content

Commit 0264073

Browse files
authored
Add note on permissions to README (#19)
1 parent 7b678bc commit 0264073

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Workflow-timer is a GitHub action that measures the duration of the workflow and
44
compares it to the duration of historical runs.
55

6-
The action should be triggered on `pull_requests` hence it will create a comment
6+
The action should be triggered on `pull_request` hence it will create a comment
77
on the PR with information like:
88

99
`🕒 Workflow "Unit tests" took 22.056s which is a decrease with 6.944s (23.94%) compared to latest run on master/main.`
@@ -20,7 +20,7 @@ As the **very last job** in your workflow, add
2020

2121
```yml
2222
- name: Time reporter
23-
uses: DeviesDevelopment/[email protected].2
23+
uses: DeviesDevelopment/[email protected].4
2424
```
2525
2626
Workflow-timer compares the current workflow run with the latest run on the
@@ -36,6 +36,15 @@ on:
3636
branches: master
3737
```
3838
39+
If workflow-timer is used in a private repository, additional permissions are
40+
required. Add the following permissions to the workflow:
41+
42+
```yaml
43+
permissions:
44+
actions: read
45+
pull-requests: write
46+
```
47+
3948
## How to contribute
4049
4150
Feel free to open a pull request! All contributions, no matter how small, are

0 commit comments

Comments
 (0)