Skip to content

Commit f487388

Browse files
authored
Docs typo (#225)
- fix a docs typo about `pull-requests` permissions - add write permissions to token in self-test CI - improve self-test CI step that shows `*checks-failed` outputs
1 parent d622b2b commit f487388

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

.github/workflows/self-test.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ on:
1818

1919
jobs:
2020
test:
21+
permissions:
22+
issues: write
23+
pull-requests: write
2124
strategy:
2225
matrix:
2326
os: [ ubuntu-latest, macos-latest, windows-latest ]
@@ -61,7 +64,8 @@ jobs:
6164
# if: steps.linter.outputs.checks-failed > 0
6265
run: |
6366
echo "some linter checks failed"
64-
echo "${{ steps.linter.outputs.checks-failed }}"
65-
echo "${{ env.checks-failed }}"
67+
echo "total checks-failed: ${{ steps.linter.outputs.checks-failed }}"
68+
echo "clang-tidy checks-failed: ${{ steps.linter.outputs.clang-tidy-checks-failed }}"
69+
echo "clang-format checks-failed: ${{ steps.linter.outputs.clang-format-checks-failed }}"
6670
# for actual deployment
6771
# run: exit 1

docs/action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ inputs:
3636
tidy-review:
3737
experimental: true
3838
minimum-version: '2.9.0'
39-
required-permission: 'pull_request: write #pull-request-reviews'
39+
required-permission: 'pull-requests: write #pull-request-reviews'
4040
format-review:
4141
minimum-version: '2.9.0'
42-
required-permission: 'pull_request: write #pull-request-reviews'
42+
required-permission: 'pull-requests: write #pull-request-reviews'
4343
outputs:
4444
checks-failed:
4545
minimum-version: '1.2.0'

docs/permissions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The [`thread-comments`](inputs-outputs.md#thread-comments) feature requires the
2929
```yaml
3030
permissions:
3131
issues: write # (1)!
32-
pull_requests: write # (2)!
32+
pull-requests: write # (2)!
3333
```
3434

3535
1. for [push events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push)
@@ -41,5 +41,5 @@ The [`tidy-review`](inputs-outputs.md#tidy-review) and [`format-review`](inputs-
4141

4242
```yaml
4343
permissions:
44-
pull_requests: write
44+
pull-requests: write
4545
```

0 commit comments

Comments
 (0)