Use detekt and ktlint as standalone tools for PR validation and reviewdog reporting

Author: OptimumCode

.github/workflows/pr-compliance-check.yml

@@ -27,41 +27,30 @@ jobs:
       id: pr-info
       run: echo "pr-number=$(cat pr/pr_number)" >> $GITHUB_OUTPUT
   reviewdog:
-    if: github.event_name == 'workflow_run'
-    needs:
-      - restore-pr
-    strategy:
-      matrix:
-        include:
-          - tool: ktlint
-            error-format: "%f:%l:%c %m"
-          - tool: detekt
-            error-format: "%f:%l:%c: %m"
+    if: github.event_name == 'pull_request_target'
     permissions:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
     - name: 'Checkout Repository'
       uses: actions/checkout@v4
-    - name: Download style reports
-      uses: dawidd6/action-download-artifact@v6
-      with:
-        name: style-reports
-        path: reports/
-        run_id: ${{ github.event.workflow_run.id }}
+    - name: Setup format tools
+      run: |
+        export DETEKT_VERSION=$(./gradlew --console plain -q printDetektVersion)
+        export KTLINT_VERSION=$(./gradlew --console plain -q printKtlintVersion)
+        ./scripts/install-format-tools.sh
     - name: Setup reviewdog
       uses: reviewdog/action-setup@v1
       with:
         reviewdog_version: latest
-    - name: Run reviewdog ${{ matrix.tool }}
-      env:
-        GITHUB_ACTIONS: "" # make reviewdog think that we are not in GitHub
-        REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        CI_PULL_REQUEST: ${{ needs.restore-pr.outputs.pr-number }}
-        CI_REPO_OWNER: ${{ github.repository_owner }}
-        CI_REPO_NAME: ${{ github.event.repository.name }}
-        CI_COMMIT: ${{ github.event.workflow_run.head_sha }}
-      run: echo reports/${{ matrix.tool }}-reviewdog.out | reviewdog -tee -reporter=github-pr-review -name=${{ matrix.tool }} -efm="${{ matrix.error-format }}"
+    - name: 'Checkout PR'
+      uses: actions/checkout@v4
+      with:
+        repository: ${{ github.event.pull_request.head.repo.full_name }}
+        ref: ${{ github.event.pull_request.head.ref }}
+    - name: Run reviewdog
+      run: reviewdog -tee -reporter=github-pr-review
+
   danger-check:
     if: github.event_name == 'pull_request_target'
     runs-on: ubuntu-latest

.github/workflows/pull_request.yml

@@ -26,48 +26,6 @@ jobs:
         path: pr/
   dump-unicode-data:
     uses: ./.github/workflows/unicode-dump.yml
-  collect-output-reviewdog:
-    needs:
-      - dump-unicode-data
-    runs-on: ubuntu-latest
-    steps:
-    - name: 'Checkout Repository'
-      uses: actions/checkout@v4
-    - uses: actions/setup-java@v4
-      with:
-        distribution: temurin
-        java-version-file: .java-version
-    - name: Validate Gradle Wrapper
-      uses: gradle/actions/wrapper-validation@v4
-    - name: Cache konan
-      uses: actions/cache@v4
-      with:
-        path: ~/.konan
-        key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
-        restore-keys: |
-          ${{ runner.os }}-gradle-
-    - name: Cache unicode data
-      uses: actions/cache@v4
-      with:
-        enableCrossOsArchive: true
-        fail-on-cache-miss: true
-        path: unicode_dump
-        key: unicode-dump-${{ hashFiles('unicode_dump/*') }}
-        restore-keys: |
-          unicode-dump-
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4
-      with:
-        gradle-version: wrapper
-    - name: Run ktlint
-      run: ./gradlew ktlintCheck --console plain > ktlint-reviewdog.out 2>&1 || true
-    - name: Run detekt
-      run: ./gradlew -q detekt detektAll --console plain > detekt-reviewdog.out 2>&1 || true
-    - name: Collect output for reviewdog
-      uses: actions/upload-artifact@v4
-      with:
-        name: style-reports
-        path: '*-reviewdog.out'
   check-pr:
     needs:
       - dump-unicode-data

.reviewdog.yml

@@ -0,0 +1,13 @@
+runner:
+  detekt:
+    cmd: "detekt-cli -c config/detekt/detekt.yml --includes '**/src/*Main/**/*.kt;**/src/main/**/*.kt'"
+    errorformat:
+      - "%f:%l:%c: %m"
+    name: detekt
+    level: error
+  ktlint:
+    cmd: "ktlint '**/*.kt' '**/*.kts' '!**/build/generated*/**'"
+    errorformat:
+      - "%f:%l:%c %m"
+    name: ktlint
+    level: error

build.gradle.kts

@@ -28,4 +28,12 @@ nexusPublishing {
       password.set(ossrhPassword)
     }
   }
+}
+
+tasks.register("printKtlintVersion") {
+  println(libs.versions.ktlint.get())
+}
+
+tasks.register("printDetektVersion") {
+  println(libs.versions.detekt.get())
 }

scripts/install-format-tools.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+if [[ "$DETEKT_VERSION" == "" ]]; then
+	echo "Privide detekt version in DETEKT_VERSION env variable"
+	exit 1
+fi
+if [[ "$KTLINT_VERSION" == "" ]]; then
+	echo "Provide ktlint version in KTLINT_VERSION env variable"
+	exit 1
+fi
+echo "Installing detekt"
+jar_destination="${HOME}/.local/lib/detekt"
+mkdir -p ${jar_destination}
+curl -sSL -o ${jar_destination}/detekt-cli.jar "https://github.com/detekt/detekt/releases/download/v${DETEKT_VERSION}/detekt-cli-${DETEKT_VERSION}-all.jar"
+
+entrypoint_script="${HOME}/.local/bin/detekt-cli"
+cat > "$entrypoint_script" << EOM
+#!/bin/bash
+java -jar ${jar_destination}/detekt-cli.jar \$@
+EOM
+chmod +x "$entrypoint_script"
+detekt-cli --version
+
+echo "Installing ktlint"
+curl -sSLO "https://github.com/pinterest/ktlint/releases/download/$KTLINT_VERSION/ktlint" && chmod a+x ktlint && mv ktlint ~/.local/bin/
+ktlint --version