【CakePHP5】PHPStanをGitHubActionsで使う

はじめに

こんにちは、エンジニアのkeitaMaxです。

前回PHPStanをローカルでコマンドを打って実行したので、今回はPushした時にGitHub上で実行するようにしようと思います。

GitHubActionsの設定ファイル

.github/workflowsディレクトリを作成し、phpstan.ymlファイルを作成します。

phpstan.yml

name: LaraStan
on: [pull_request]

jobs:
  phpstan:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./src
    steps:
      - uses: actions/checkout@v2
      - name: dokcer-compose up
        run: |
          docker-compose up -d

      - name: Composer install
        run: docker compose exec app composer install

      - name: Run PHPStan
        run: docker compose exec app composer stan

これは以前の記事で作成したLaravelのymlファイルを参考にしています。

実際にPushする

実際にGitHubにPushしてみます。

すると以下のようにGitHubActionsが動いているのがわかります。

実行が終わると、以下のようになります。

これでGitHub上でPHPStanを実行することができました。

失敗させてみる

正しく動いているか確かめるために失敗させてみます。

Controllerの}をわざと削除してPHPStanでエラーが出るようにしてPushしてみます。

すると以下のようにエラーになるのがわかります。

ただしくPHPStanがGitHub上で動作していることが確認できました。

おわりに

この記事での質問や、間違っている、もっといい方法があるといったご意見などありましたらご指摘していただけると幸いです。

最後まで読んでいただきありがとうございました！

参考