【CakePHP5】CodeSnifferをGitHubActionsで使う

はじめに

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

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

GitHubActionsの設定ファイルの作成

.github/workflows/phpcs.ymlファイルを作成します。

phpcs.yml

name: phpcs

on: [pull_request]

jobs:
  phpcs:
    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 CodeSniffer
        run: |
          docker compose exec app composer cs-check

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

Pushして実行する

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

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

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

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

失敗させてみる

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

AppControllerのinitialize(): voidこの記述をinitialize():voidこのように半角スペースを消してPushしてみます。

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

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

おわりに

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

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

参考

次の記事