doc: Mention setting up the Go environment DOCS-380

codacy · Aug 19, 2022 · 4dd5785 · 4dd5785
1 parent 570228a
commit 4dd5785
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -147,6 +147,16 @@ To use the GitHub Action with Codacy integration:
               max-allowed-issues: 2147483647
     ```
 
+    **If you're running a Go client-side tool** you must also set up the Go environment before running the Codacy Analysis CLI GitHub Action. We recommend using the [setup-go GitHub Action](https://github.com/actions/setup-go) for this:
+
+    ```yaml
+    - name: set-up go
+      uses: actions/setup-go@v3
+      with:
+        # Go version currently supported by Codacy
+        go-version: 1.17.13
+    ```
+
 4.  Optionally, specify the following parameters to run [**standalone** client-side tools](https://docs.codacy.com/related-tools/local-analysis/client-side-tools/):
 
     ```yaml