spotbugs github action

Spotbugs github動作

此操作將spotbugs（或findbugs）的結果作為檢查運行註釋。

該動作也可以用於以XML格式生成報告的任何其他靜態分析工具。該報告本身必須在以前的構建步驟中生成，例如Maven構建。

輸入

path

必需的。文件，目錄或通配符模式，可描述在哪裡找到報告。可以通過Glob表達式處理多個文件，例如： '**/spotbugsXml.xml' 。

name

選修的。運行支票的名稱要創建。默認為spotbugs 。

title

選修的。支票運行的標題要創建。默認為SpotBugs Source Code Analyzer report 。

token

選修的。 github api訪問令牌。默認為${{ github.token }} ，該}是由actions/checkout@v2最小化設置的。

示例用法

 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 '

並且不要忘記為Maven插件啟用XML輸出：

< 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 >

請注意，默認情況下， pull_request事件上的工作流結帳refs/pull/:prNumber/merge而不是拉請求的頭部。因此，生成的違規行為的行號可能與它們在HEAD上顯示的實際線號不符。實際上，實際上並沒有一種明智的方法可以在拉動請求的合併提交中運行此操作，因為結果將發佈到未命名的工作流程中，以進行原本隱形的提交。即使對於pull_request事件，也有可能檢查拉申請頭。為此，請相應地更改您的checkout行動：

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

其他相關行動

這是一系列其他GitHub動作中的GitHub動作。類似的行動包括：

• checkstyle-github-action
• pmd-github-action
• spotbugs-github-action

已知限制

由於GitHub API的限制，我們無法指定應關聯新創建的檢查運行的工作流程運行（或基礎檢查套件）。結果，觸發幾種類型的事件的工作流程可能會在另一個事件下推動結果，而不是進行操作。有關更多信息，請參見：＃3

貢獻

安裝依賴項

$ npm install

構建打字稿並打包以進行分發

$ npm run build && npm run package

運行測試✔️

$ npm test

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

...