sonarqube action

Sonarqube Github Action

Usando esta ação do Github, digitalize seu código com o Sonarqube Scanner para detectar bugs, vulnerabilidades e o código cheira em mais de 20 linguagens de programação!

O Sonarqube é uma plataforma de código aberto desenvolvido pela SonarSource para inspeção contínua da qualidade do código para realizar análises automáticas com análise estática do código para detectar bugs, cheiros de código e vulnerabilidades de segurança em mais de 20 linguagens de programação.

Requisitos

• Servidor sonarqube.
• Isso é tudo!

Uso

O fluxo de trabalho, geralmente declarado em .github/workflows/build.yaml , parece:

 on :
  # Trigger analysis when pushing in master or pull requests, and when creating
  # a pull request. 
  push :
    branches :
      - master
  pull_request :
      types : [opened, synchronize, reopened]

name : SonarQube Scan
jobs :
  sonarqube :
    name : SonarQube Trigger
    runs-on : ubuntu-latest
    steps :
    - name : Checking out
      uses : actions/checkout@master
      with :
        # Disabling shallow clone is recommended for improving relevancy of reporting
        fetch-depth : 0
    - name : SonarQube Scan
      uses : kitabisa/[email protected]
      with :
        host : ${{ secrets.SONARQUBE_HOST }}
        login : ${{ secrets.SONARQUBE_TOKEN }}

Você pode alterar o diretório da base de análise e/ou a chave do projeto usando a entrada opcional como esta:

 uses : kitabisa/sonarqube-action@master
with :
  host : ${{ secrets.SONARQUBE_HOST }}
  login : ${{ secrets.SONARQUBE_TOKEN }}
  projectBaseDir : " src/ "
  projectKey : " my-custom-project "

Entradas

Estes são alguns dos parâmetros de ação de entrada suportados.

Parâmetro	Descrição	Obrigatório?	Padrão	Observação
host	URL do servidor sonarqube	?
login	Login ou token de autenticação de um usuário sonarqueiro	?		Execute Analysis necessária.
password	A senha que acompanha o nome de usuário login	?		Isso deve ser deixado em branco se um login for um token de autenticação.
projectBaseDir	Definir análise de diretório base de projeto personalizado	?	.
projectKey	A chave única do projeto	?		Os caracteres permitidos são: letras, números, - , _ , . e : com pelo menos um não dígito.
projectName	Nome do projeto	?		Ele será exibido na interface da Web Sonarqube.
projectVersion	A versão do projeto	?
encoding	Codificação do código -fonte	?	UTF-8

Observação

Se você optar por configurar os metadados do projeto e outras configurações relacionadas em um arquivo sonar-project.properties (deverá ser colocado no diretório base, projectBaseDir ) em vez de usar parâmetros de entrada, esta ação é compatível com essa abordagem!

Licença

O Dockerfile e os scripts e a documentação associados neste projeto são divulgados sob a licença do MIT.

As imagens de contêineres construídas com este projeto incluem materiais de terceiros.