doc: introduce reviewdog/action-setup

https://github.com/reviewdog/action-setup
reviewdog · Aug 8, 2020 · e5279b1 · e5279b1
1 parent 201c5e3
commit e5279b1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml
@@ -21,8 +21,6 @@ jobs:
 
       - name: Setup reviewdog
         run: |
-          # mkdir -p $HOME/bin && curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b $HOME/bin
-          # echo ::add-path::$HOME/bin
           go install ./cmd/reviewdog
 
       - name: Run reviewdog
@@ -74,8 +72,6 @@ jobs:
 
       - name: Setup reviewdog
         run: |
-          # mkdir -p $HOME/bin && curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b $HOME/bin
-          # echo ::add-path::$HOME/bin
           go install ./cmd/reviewdog
 
       - name: Run reviewdog (github-pr-check)

diff --git a/README.md b/README.md
@@ -119,10 +119,13 @@ to try the latest reviewdog improvements every day!
 $ curl -sfL https://raw.githubusercontent.com/reviewdog/nightly/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
 ```
 
-### Build from HEAD with go get
+### GitHub Action: [reviewdog/action-setup](https://github.com/reviewdog/action-setup)
 
-```shell
-$ go get -u github.com/reviewdog/reviewdog/cmd/reviewdog
+```yaml
+steps:
+- uses: reviewdog/action-setup@v1
+  with:
+    reviewdog_version: latest # [latest,nightly,v.X.Y.Z]
 ```
 
 ### homebrew / linuxbrew
@@ -133,6 +136,12 @@ $ brew install reviewdog/tap/reviewdog
 $ brew upgrade reviewdog/tap/reviewdog
 ```
 
+### Build from HEAD with go get
+
+```shell
+$ go get -u github.com/reviewdog/reviewdog/cmd/reviewdog
+```
+
 ## Input Format
 
 ### 'errorformat'
@@ -441,10 +450,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # ...
-      - name: Setup reviewdog
-        run: |
-          mkdir -p $HOME/bin && curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b $HOME/bin
-          echo ::add-path::$HOME/bin
+      - use: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: latest # [latest,nightly,v.X.Y.Z]
       - name: Run reviewdog
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}