spotbugs github action

Spotbugs github 액션

이 조치는 SpotBugs (또는 FindBugs)의 결과를 검사 실행 주석으로 추진합니다.

이 작업은 SpotBugs XML 형식의 보고서를 생성하는 다른 정적 분석 도구에도 사용될 수 있습니다. 보고서 자체는 이전 빌드 단계 (예 : Maven 빌드)에서 생성되어야합니다.

입력

path

필수의. 보고서를 찾을 위치를 설명하는 파일, 디렉토리 또는 와일드 카드 패턴. '**/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 이벤트에서 기본적으로 워크 플로우는 PUT 요청의 헤드 대신 refs/pull/:prNumber/merge 입니다. 이로 인해 생성 된 위반의 줄 번호는 HEAD 에 표시되는 실제 줄 번호와 일치하지 않을 수 있습니다. 그대로, 결과는 다른 보이지 않는 커밋을 위해 이름이없는 워크 플로에 게시되기 때문에 풀 요청의 병합 커밋 에서이 조치를 실행하는 현명한 방법은 없습니다. pull_request 이벤트의 경우에도 Pull Request Head를 대신 체크 아웃 할 수 있습니다. 그렇게하려면 checkout 조치를 변경하십시오.

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

다른 관련 조치

이것은 일련의 다른 GitHub 동작에서 GitHub 동작입니다. 비슷한 조치는 다음과 같습니다.

• CheckStyle-Github-Action
• PMD-github- 액션
• Spotbugs-Github-Action

알려진 한계

GitHub API 제한으로 인해 새로 생성 된 체크 실행이 연관되어야하는 워크 플로 실행 (또는 기본 체크 스위트)을 지정할 수 없습니다. 결과적으로 여러 유형의 이벤트를 트리거하는 워크 플로우는 작업이 실행되는 것보다 다른 이벤트에서 결과를 푸시 할 수 있습니다. 자세한 내용은 다음을 참조하십시오. #3.

기여

종속성을 설치하십시오

$ npm install

TypeScript를 작성하고 배포를 위해 패키지하십시오

$ npm run build && npm run package

테스트를 실행하십시오

$ npm test

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

...