phpunit matcher action

phpunit-matcher-action

このアクションは、組み込みの PHPUnit --teamcityフォーマッタを使用して、Github Actions ビルドに注釈を追加します。

使用法

これらのマッチャーを構成するには、 --teamcityフラグを指定して PHPUnit を実行する前に、ワークフロー YAML ファイルに次のステップを追加します。

- name : Configure matchers
  uses : mheap/phpunit-matcher-action@v1

これは、テストを実行し、失敗に対する注釈を追加する完全なワークフローの例 ( .github/workflows/phpunit.ymlにあります) です。

 name : PHPUnit
on : [pull_request]
jobs :
  build :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
    - name : Composer dependencies
      run : composer install --no-ansi --no-interaction --no-scripts --no-suggest --no-progress --prefer-dist
    - name : Configure matchers
      uses : mheap/phpunit-matcher-action@v1
    - name : Run Tests
      run : ./vendor/bin/phpunit --teamcity test

コンテナーでテストを実行し、Teamcity の出力に異なるベース パスが含まれる場合は、 base_path入力を使用してそれを指定できます。

- name : Configure matchers
  uses : mheap/phpunit-matcher-action@v1
  with :
    base_path : /path/to/other/folder 

仕組み

問題マッチャーは、正規表現を定義して、出力ログからファイル、行番号、重大度などの情報を抽出することによって機能します。各マッチャーは::add-matcher::/path/to/matcher.json出力に追加して、Github Actions に登録する必要があります。

このアクションは、Github ワークスペースに基づいて正規表現を生成し、マッチャー ファイルを書き出して、それらをアクション ランナーに登録します。

必要な情報 (ファイル パス、失敗メッセージ、行番号) がすべて含まれているため、Teamcity 出力を使用します。