@@ -257,59 +257,6 @@ codacy-analysis-cli analyse \
257257
258258> In alternative to setting ` --api-token ` you can define CODACY_API_TOKEN in the environment.
259259
260- ## GitHub Action
261-
262- The analysis CLI is available to be executed as a GitHub Action. The following is an example of a workflow
263- using the CLI as an action, to analyse each commit and pull request.
264-
265- ``` yaml
266- name : codacy-analysis-cli
267-
268- on : ["push"]
269-
270- jobs :
271- codacy-analysis-cli :
272- runs-on : ubuntu-latest
273- name : codacy-analysis-cli
274- steps :
275- - name : Checkout code
276- uses : actions/checkout@master
277- - name : Run codacy-analysis-cli
278- uses : codacy/codacy-analysis-cli@master
279- ` ` `
280-
281- Running the action with the default configurations will:
282-
283- - Analyse the current commit or pull request running all supported tools, with the default configuration,
284- for the languages you are using.
285- - Print analysis results into the console (you can check them in GitHub's action workflow panel).
286- - Fail the workflow if at least one issue is found in your code.
287-
288- Check the next section to see how you can further configure this action.
289-
290- ### Caveats
291-
292- This action supports all [CLI configuration options](#commands-and-configuration) with the following exceptions:
293-
294- - ` --commit-uuid` -- **Not supported**. The action will only analyse the commit that triggered it.
295- - ` --api-token` -- **Not supported**. Use [`--project-token`](#project-token) instead.
296- - ` --username` -- **Not supported**. Use [`--project-token`](#project-token) instead.
297- - ` --project` -- **Not supported**. Use [`--project-token`](#project-token) instead.
298-
299- The command `validate-configuration` is also **not supported**.
300-
301- When using `--project-token` make sure to use [GitHub security features](#https://docs.github.com/en/actions/reference/encrypted-secrets)
302- to prevent you from committing a secret token to your code. For example, if you store your Codacy project
303- token in GitHub, this is how you would use it in the action workflow.
304-
305- ` ` ` yaml
306- # ...
307- uses: codacy/codacy-analysis-cli@master
308- with:
309- project-token: ${{ secrets.<PROJECT_TOKEN_NAME> }}
310- # ...
311- ` ` `
312-
313260## Build
314261
315262### Compile
0 commit comments