Ktlint × ReviewDogでPull Requestをレビューする

import org.jlleitschuh.gradle.ktlint.reporter.ReporterType

plugins {
    alias(libs.plugins.android.application) apply false
    alias(libs.plugins.kotlin.android) apply false
    alias(libs.plugins.kotlin.compose) apply false
    alias(libs.plugins.android.library) apply false
    id("org.jlleitschuh.gradle.ktlint") version "12.1.1" apply false
}

// appとlibraryの2つのモジュールでktlint-gradleを有効化する
allprojects {
    // ktlint-gradleのpluginを有効にする
    apply(plugin = "org.jlleitschuh.gradle.ktlint")
    configure<org.jlleitschuh.gradle.ktlint.KtlintExtension> {
        // Ktlintのバージョンを指定する
        version.set("1.3.1")
     
        // Ktlintの実行結果をPLAIN・CHECKSTYLE・SARIFで出力する
        reporters {
            reporter(ReporterType.PLAIN)
            reporter(ReporterType.CHECKSTYLE)
            reporter(ReporterType.SARIF)
        }
        
        // Ktlintを実行して、警告・エラーがあり失敗しても、無視するようにする
        ignoreFailures.set(true)

        // Ktlintを実行する際に自動生成されたコードは無視する、kotlinディレクトリにあるコードを対象にする
        filter {
            exclude("**/generated/**")
            include("**/kotlin/**")
        }
    }
}

katz@macbookpro AndroidReviewdogDemo % ./gradlew ktlintCheck 

BUILD SUCCESSFUL in 2s
13 actionable tasks: 11 executed, 2 up-to-date

BUILD SUCCESSFUL in 2s
13 actionable tasks: 11 executed, 2 up-to-date
katz@macbookpro AndroidReviewdogDemo % ./gradlew ktlintFormat

name: Check pull request

on:
  pull_request

permissions:
  contents: write
  
jobs:
  check:
    runs-on: ubuntu-latest
    name: Check pull request
    permissions:
      pull-requests: write
    steps:
      # 1. 最新のプロジェクトをチェックアウトする
      - uses: actions/checkout@v4

      # 2. プロジェクトのビルドを実行するために必要なJava環境をセットアップする
      - uses: actions/setup-java@v4
        with:
          distribution: 'corretto'
          java-version: 17

      # 3. ReviewDogの公式が提供しているActionを利用して、ReviewDogをセットアップする
      - name: Setup reviewdog
        uses: reviewdog/action-setup@v1
        with:
          reviewdog_version: v0.18.0

      # 4. ktlint-gradleが提供するktlintCheckタスクを実行して、Ktlintの静的解析レポートを生成する
      - name: ktlint
        run: ./gradlew ktlintCheck

      # 5. Ktlintの静的解析レポートを検索して、順番にReviewDogに読み込ませて、Pull Requestコメントを生成する<strong>
      - name: Run reviewdog for Ktlint
        env:</strong>
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEW_DOG }}
        # Reporterにはgithub-pr-checkを利用する場合はこちら、Files Changedのレビューコメントが記載される
        run: |
          find . -regex '^.*/build/reports/ktlint/ktlintMainSourceSetCheck/ktlintMainSourceSetCheck.sarif' -type f | while read file_path; do
           cat "$file_path" | reviewdog -reporter=github-pr-check -f=sarif -fail-on-error
          done