codacy analysis cli action
v4.4.5
Ação do GitHub para executar a análise estática da codacia em mais de 40 idiomas suportados e retornar problemas identificados no código.
O Codacy é uma ferramenta de revisão de código automatizada que facilita a garantia de garantir que sua equipe esteja escrevendo código de alta qualidade, analisando mais de 40 linguagens de programação como PHP, JavaScript, Python, Java e Ruby. O Codacy permite definir suas próprias regras de qualidade, padrões de código e configurações de qualidade que você deseja aplicar para evitar problemas na sua base de código.
A ação do Codacy Github suporta os seguintes cenários:
Por padrão, o Codacy Github Action:
Para usar a ação do GitHub com as configurações padrão, adicione o seguinte a um arquivo .github/workflows/codacy-analysis.yaml em seu repositório:
name : Codacy Analysis CLI
on : ["push"]
jobs :
codacy-analysis-cli :
name : Codacy Analysis CLI
runs-on : ubuntu-latest
steps :
- name : Checkout code
uses : actions/checkout@main
- name : Run Codacy Analysis CLI
uses : codacy/codacy-analysis-cli-action@master Integre a ação do Codacy Github com a digitalização do código do GitHub para exibir os resultados da análise no seu repositório sob a segurança da guia, alertas de digitalização de código de página.
Nesse cenário, a ação do github:
master ou ramificação main executando todas as ferramentas de análise de código estático suportadas para os idiomas encontrados no seu repositório.results.sarif , que é enviado para o GitHub. 
Para usar a ação do github com a integração de varredura do código do github, adicione o seguinte a um arquivo .github/workflows/codacy-analysis.yaml em seu repositório:
name : Codacy Security Scan
on :
push :
branches : [ "master", "main" ]
pull_request :
branches : [ "master", "main" ]
jobs :
codacy-security-scan :
name : Codacy Security Scan
runs-on : ubuntu-latest
steps :
- name : Checkout code
uses : actions/checkout@main
- name : Run Codacy Analysis CLI
uses : codacy/codacy-analysis-cli-action@master
with :
output : results.sarif
format : sarif
# Adjust severity of non-security issues
gh-code-scanning-compat : true
# Force 0 exit code to allow SARIF file generation
# This will hand over control about PR rejection to the GitHub side
max-allowed-issues : 2147483647
# Upload the SARIF file generated in the previous step
- name : Upload SARIF results file
uses : github/codeql-action/upload-sarif@main
with :
sarif_file : results.sarif Use a ação do GitHub para executar qualquer uma das ferramentas do lado do cliente em contêiner suportadas pelo Codacy e fazer o upload dos resultados da análise para o Codacy.
Nesse cenário, a ação do github:
Depois disso, o Codacy exibe os resultados da análise de suas comissões e solicitações nos painéis da interface do usuário e, opcionalmente, relata o status da análise diretamente em suas solicitações de tração no Github.
Para usar a ação do GitHub com a integração de codacia:
No Codacy, ative a ferramenta do lado do cliente em contêiner e configure os padrões de código correspondentes na página Padrões de código do repositório.
No Codacy, ative a análise de execução através do Build Server em suas configurações de repositório, guia Geral , Análise do Repositório .
Essa configuração permite que o Codacy aguarde os resultados da análise local antes de retomar a análise de seus compromissos.
Configure um token da API para permitir que a ação do GitHub se autentique no Codacy:
CODACY_PROJECT_TOKEN .CODACY_API_TOKEN .
️ Nunca escreva tokens de API nos seus arquivos de configuração e mantenha seus tokens de API bem protegidos, pois eles concedem permissões do proprietário aos seus projetos no Codacy.
Adicione o seguinte a um arquivo .github/workflows/codacy-analysis.yaml em seu repositório, onde <CLIENT_SIDE_TOOL_NAME> é o nome da ferramenta do lado do cliente que a CLI da análise de codacia será executada localmente ou não especificará esse parâmetro para executar todas as ferramentas suportadas por codacia:
name : Codacy Analysis CLI
on : ["push"]
jobs :
codacy-analysis-cli :
name : Codacy Analysis CLI
runs-on : ubuntu-latest
steps :
- name : Checkout code
uses : actions/checkout@main
- name : Run Codacy Analysis CLI
uses : codacy/codacy-analysis-cli-action@master
with :
tool : <CLIENT_SIDE_TOOL_NAME>
project-token : ${{ secrets.CODACY_PROJECT_TOKEN }}
# or
# api-token: ${{ secrets.CODACY_API_TOKEN }}
upload : true
max-allowed-issues : 2147483647Se você estiver executando uma ferramenta GO do lado do cliente, também deve configurar o ambiente Go antes de executar a ação do CLI Github. Recomendamos o uso da ação do Github de configuração para isso:
- name : set-up go
uses : actions/setup-go@v3
with :
# Go version currently supported by Codacy
go-version : 1.19.1Opcionalmente, especifique os seguintes parâmetros para executar ferramentas independentes do lado do cliente:
run-gosec : " true "
run-staticcheck : " true "Devido à complexa orquestração das ferramentas, tidy e faux pas, a ação pode receber os arquivos de saída das ferramentas e carregá-las para o Codacy:
clang-tidy-output : " path/to/output "
faux-pas-output : " path/to/output "Se você deseja executar apenas as ferramentas independentes do lado do cliente e não todas as ferramentas de contêiner suportadas pelo Codacy, especifique:
run-docker-tools : " false "Opcionalmente, permita que a integração do GitHub no Codacy tenha informações sobre a análise dos arquivos alterados diretamente em suas solicitações de tração.
A ação do Codacy Github é um invólucro para executar a CLI da Codacy Analysis. Para uma lista de parâmetros de entrada suportados, consulte action.yml . Para passar os parâmetros de entrada para a ação, atualize o mapa with .
O exemplo a seguir limita a análise a um diretório src e fornece detalhes adicionais definindo verbose como true .
- name : Run Codacy Analysis CLI
uses : codacy/codacy-analysis-cli-action@master
with :
directory : src
verbose : true Adoramos contribuições, feedback e relatórios de bug. Se você tiver problemas ao executar essa ação, abra um problema neste repositório.
