Skip to content

Commit b824adf

Browse files
authored
Adds basic GitHub Action README (#115)
1 parent 0006186 commit b824adf

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,14 @@ jobs:
181181
vendor/bin/phpstan analyse --error-format=checkstyle | vendor/bin/cs2pr
182182
```
183183

184+
## Using cs2pr as a GitHub Action
185+
186+
You can also use [`cs2pr` itself as a GitHub Action](https://github.com/staabm/annotate-pull-request-from-checkstyle-action). This is useful if you want to for instance use it for a project that does not use PHP or if you want to use it with a custom PHP installation.
187+
188+
See the example at the [cs2pr GitHub Action repositiory](https://github.com/staabm/annotate-pull-request-from-checkstyle-action#readme).
189+
190+
191+
184192
# Resources
185193

186194
[GithubAction Problem Matchers](https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md)

0 commit comments

Comments
 (0)