spotbugs github action

Spotbugs Github Ação

Essa ação impulsiona os resultados de Spotbugs (ou FindBugs) como anotações de verificação.

A ação também pode ser usada para outras ferramentas de análise estática que produzem relatórios no formato XML Spotbugs. O próprio relatório deve ser gerado em uma etapa de construção anterior, por exemplo, uma construção do Maven.

Entrada

path

Obrigatório. Um padrão de arquivo, diretório ou curinga que descreve onde encontrar os relatórios. Vários arquivos podem ser processados ​​através de uma expressão glob, por exemplo: '**/spotbugsXml.xml' .

name

Opcional. Nome para a execução da verificação para criar. Padrões para spotbugs .

title

Opcional. Título para a execução do cheque para criar. Padrões do SpotBugs Source Code Analyzer report .

token

Opcional. Token de acesso à API do GitHub. Padrão para ${{ github.token }} , que é definido por actions/checkout@v2 minimamente.

Exemplo de uso

 name : Java CI

on : [push]

jobs :
  build :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
    - name : Set up JDK 1.8
      uses : actions/setup-java@v1
      with :
        java-version : 1.8
    - uses : actions/cache@v1
      with :
        path : ~/.m2/repository
        key : ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
        restore-keys : |
          ${{ runner.os }}-maven-
    - name : Build with Maven
      run : mvn -B verify spotbugs:spotbugs
    - uses : jwgmeligmeyling/spotbugs-github-action@master
      with :
        path : ' **/spotbugsXml.xml '

E não se esqueça de ativar a saída XML para o plug -in maven:

< build >
  < plugins >
    < plugin >
      < groupId >com.github.spotbugs</ groupId >
      < artifactId >spotbugs-maven-plugin</ artifactId >
      < version >4.0.0</ version >
      < configuration >
        < xmlOutput >true</ xmlOutput >
        < failOnError >false</ failOnError >
      </ configuration >
    </ plugin >
  </ plugins >
</ build >

Observe que, por padrão, fluxos de trabalho no pull_request Events Checkout refs/pull/:prNumber/merge em vez da cabeça da solicitação de tração. Devido a isso, os números de linha para as violações geradas podem não se alinhar com os números reais de linha aos quais são exibidos na HEAD . Como é, não existe realmente uma maneira sensata de executar essa ação no comprometimento da mesclagem da solicitação de tração, porque o resultado seria publicado em um fluxo de trabalho sem nome para uma confirmação invisível. Mesmo para eventos pull_request , existe a possibilidade de verificar a cabeça da solicitação de tração. Para fazer isso, mude sua ação checkout de acordo:

- uses : actions/checkout@v2
  with :
    ref : ${{ github.event.pull_request.head.sha }} 

Outras ações relevantes

Esta é uma ação do GitHub em uma série de outras ações do GitHub. Ações semelhantes incluem:

• Checkstyle-github-ação
• PMD-Github-Ação
• SpotBugs-Github-Ação

Limitações conhecidas

Devido às limitações da API do GitHub, não podemos especificar a qual fluxo de trabalho execute (ou suíte de verificação subjacente), uma execução de verificação recém -criada deve ser associada. Como resultado, os fluxos de trabalho que desencadeiam vários tipos de eventos podem pressionar os resultados sob outro evento que a ação foi executada. Para obter mais informações, consulte: #3

Contribuindo

Instalar as dependências

$ npm install

Construa o TypeScript e empacote -o para distribuição

$ npm run build && npm run package

Execute os testes ✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...