Skip to content

Commit 0b20574

Browse files
committed
Replace default usage with docker image
Signed-off-by: Riddhesh Sanghvi <riddhesh237@gmail.com>
1 parent e052531 commit 0b20574

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ on: pull_request
2323

2424
jobs:
2525
phpcs:
26-
2726
runs-on: ubuntu-latest
28-
2927
steps:
3028
- uses: actions/checkout@v2
3129
with:
3230
ref: ${{ github.event.pull_request.head.sha }}
33-
- uses: rtCamp/action-phpcs-code-review@v2.0.0
31+
- uses: docker://rtcamp/action-phpcs-code-review:v2.0.0
3432
env:
3533
GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
3634
with:
@@ -43,6 +41,10 @@ Now, next time you create a pull request or commit on an existing pull request,
4341

4442
By default, pull request will be reviwed using WordPress coding and documentation standards. You can change the default by passing different [PHPCS Coding Standard(s)](#phpcs-coding-standards) in line `args = ["WordPress-Core,WordPress-Docs"]`.
4543

44+
---
45+
46+
Side note: in the usage example, we have used `docker://rtcamp/action-phpcs-code-review:v2.0.0`, which is the docker image set up with automated builds on this repo. It will always have the latest code of this repo. Instead of using docker image you can also use the repo url in it: `rtCamp/action-phpcs-code-review@v2.0.0`. The disadvantage using the repo url is that GitHub actions now builds the docker image from url every time action is executed (does not cache the docker image after first run _by default_ as it used to do in beta. You need to cache them seprately). That consumes a fairly good amount of time in action run. Leading to a longer running job as well as more billing (if used in private repo).
47+
4648
## GitHub Token Creation
4749

4850
You can create [GitHub Token from here](https://github.com/settings/tokens).

0 commit comments

Comments
 (0)