pmd github action

PMD Githubアクション

このアクションは、Check Run AnnotationsとしてのPMDからの結果を押します。

このアクションは、PMD XML形式でレポートを作成する他の静的分析ツールにも使用できます。レポート自体は、たとえばMavenビルドなど、以前のビルドステップで生成する必要があります。

入力

path

必須。レポートを見つける場所を説明するファイル、ディレクトリ、またはワイルドカードパターン。たとえば、グローブ式、 '**/pmd.xml'など、複数のファイルを処理できます。

name

オプション。作成するチェック実行の名前。デフォルトはPMDになります。

title

オプション。 Check Runのタイトルを作成します。デフォルトはPMD 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 pmd:pmd
    - uses : jwgmeligmeyling/pmd-github-action@master
      with :
        path : ' **/pmd.xml '

そして、MavenプラグインのXML出力を有効にすることを忘れないでください：

< build >
  < plugins >
    < plugin >
      < groupId >org.apache.maven.plugins</ groupId >
      < artifactId >maven-pmd-plugin</ artifactId >
      < version >3.13.0</ version >
      < configuration >
        < includeTests >true</ includeTests >
        < failOnViolation >false</ failOnViolation >
        < skipEmptyReport >false</ skipEmptyReport >
      </ 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の制限により、新しく作成されたチェックランを関連付ける必要があるワークフローの実行（または基礎となるチェックスイート）を指定することはできません。その結果、いくつかのタイプのイベントをトリガーするワークフローは、アクションが実行されたよりも別のイベントで結果をプッシュする可能性があります。詳細については、＃4を参照してください。

貢献

依存関係をインストールします。

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

...