spotbugs github action

SPOTBUGS GITHUB ACTION

Tindakan ini mendorong hasil dari SpotBugs (atau FindBugs) sebagai periksa anotasi Run.

Tindakan ini juga dapat digunakan untuk alat analisis statis lainnya yang menghasilkan laporan dalam format XML SpotBugs. Laporan itu sendiri harus dihasilkan dalam langkah bangunan sebelumnya, misalnya build Maven.

Masukan

path

Diperlukan. Pola file, direktori atau wildcard yang menjelaskan di mana menemukan laporan. Beberapa file dapat diproses melalui ekspresi glob, misalnya: '**/spotbugsXml.xml' .

name

Opsional. Nama untuk Run Check untuk membuat. Default ke spotbugs .

title

Opsional. Judul untuk menjalankan cek untuk membuat. Default ke SpotBugs Source Code Analyzer report .

token

Opsional. Token Akses API GitHub. Default ke ${{ github.token }} , yang ditetapkan oleh actions/checkout@v2 minimal.

Contoh penggunaan

 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 '

Dan jangan lupa untuk mengaktifkan output XML untuk plugin 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 >

Harap dicatat bahwa secara default alur kerja di pull_request Events Checkout refs/pull/:prNumber/merge bukan kepala permintaan tarik. Karena ini, nomor baris untuk pelanggaran yang dihasilkan mungkin tidak selaras dengan nomor baris aktual yang ditampilkan di HEAD . Karena itu, tidak ada cara yang masuk akal untuk menjalankan tindakan ini pada komit gabungan dari permintaan tarik, karena hasilnya akan diposting ke alur kerja yang tidak disebutkan namanya untuk komitmen yang tidak terlihat. Bahkan untuk acara pull_request ada kemungkinan untuk memeriksa kepala permintaan tarik sebagai gantinya. Untuk melakukannya, ubah tindakan checkout Anda sesuai:

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

Tindakan relevan lainnya

Ini adalah tindakan GitHub dalam serangkaian tindakan GitHub lainnya. Tindakan serupa termasuk:

• Action-github-action
• PMD-Github-action
• spotbugs-github-action

Keterbatasan yang diketahui

Karena keterbatasan API GitHub, kami tidak dapat menentukan yang dijalankan alur kerja (atau rangkaian cek yang mendasari) pemeriksaan yang baru dibuat harus dikaitkan. Akibatnya, alur kerja yang memicu beberapa jenis peristiwa, mungkin mendorong hasil di bawah peristiwa lain daripada tindakan dijalankan. Untuk informasi lebih lanjut, lihat: #3

Berkontribusi

Instal dependensi

$ npm install

Bangun naskah dan kemas untuk distribusi

$ npm run build && npm run package

Jalankan tes ✔️

$ npm test

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

...