Skip to content

Commit a65ec27

Browse files
authored
recommend requesting permissions (#53)
* mention that `issues: write` permissions should be requested * correct yaml syntax * warn more strongly * don't mention the setting twice * don't recommend using the global setting for issue permissions
1 parent 44ec2bb commit a65ec27

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ How this works:
1414

1515
To use the `issue-from-pytest-log` action in workflows, simply add a new step:
1616

17+
> [!WARNING]
18+
> The action won't run properly unless the `issues: write` permission is requested as shown below.
19+
1720
```yaml
1821
jobs:
1922
my-job:
@@ -22,6 +25,9 @@ jobs:
2225
fail-fast: false
2326
...
2427

28+
permissions:
29+
issues: write
30+
2531
...
2632

2733
- uses: actions/setup-python@v4
@@ -31,12 +37,12 @@ jobs:
3137

3238
...
3339

34-
- run: <
40+
- run: |
3541
pip install --upgrade pytest-reportlog
3642
3743
...
3844

39-
- run: <
45+
- run: |
4046
pytest --report-log pytest-log.jsonl
4147
4248
...

0 commit comments

Comments
 (0)