Merge pull request #6637 from vector-im/feature/bma/danger

Danger

.github/workflows/danger.yml

@@ -0,0 +1,18 @@
+name: Danger CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Danger
+    steps:
+      - uses: actions/checkout@v3
+      - run: |
+          npm install --save-dev @babel/plugin-transform-flow-strip-types
+      - name: Danger
+        uses: danger/[email protected]
+        with:
+          args: "--dangerfile tools/danger/dangerfile.js"
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}

.github/workflows/quality.yml

@@ -29,80 +29,50 @@ jobs:
       - uses: actions/checkout@v3
       - name: Run knit
         run: |
-          ./gradlew knit
+          ./gradlew knitCheck
 
-  # ktlint for all the modules
-  ktlint:
-    name: Kotlin Linter
+  # Check the project: ktlint, detekt, lint
+  lint:
+    name: Android Linter
     runs-on: ubuntu-latest
     # Allow all jobs on main and develop. Just one per PR.
     concurrency:
-      group: ${{ github.ref == 'refs/heads/main' && format('ktlint-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('ktlint-develop-{0}', github.sha) || format('ktlint-{0}', github.ref) }}
+      group: ${{ github.ref == 'refs/heads/main' && format('lint-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('lint-develop-{0}', github.sha) || format('lint-{0}', github.ref) }}
       cancel-in-progress: true
     steps:
       - uses: actions/checkout@v3
       - name: Run ktlint
         run: |
           ./gradlew ktlintCheck --continue
+      - name: Run detekt
+        if: always()
+        run: |
+          ./gradlew detekt $CI_GRADLE_ARG_PROPERTIES
+      - name: Run lint
+        # Not always, if ktlint or detekt fail, avoid running the long lint check.
+        run: |
+          ./gradlew lintGplayRelease --stacktrace $CI_GRADLE_ARG_PROPERTIES
+          ./gradlew lintFdroidRelease --stacktrace $CI_GRADLE_ARG_PROPERTIES
       - name: Upload reports
         if: always()
         uses: actions/upload-artifact@v3
         with:
-          name: ktlinting-report
+          name: linting-report
           path: |
-            */build/reports/ktlint/ktlint*/ktlint*.txt
-      - name: Handle Results
+            */build/reports/**/*.*
+      - name: Prepare Danger
         if: always()
-        id: ktlint-results
         run: |
-          results="$(cat */*/build/reports/ktlint/ktlint*/ktlint*.txt */build/reports/ktlint/ktlint*/ktlint*.txt | sed -r "s/\x1B\[([0-9]{1,3}(;[0-9]{1,2})?)?[mGK]//g")"
-          if [ -z  "$results" ]; then
-            echo "::set-output name=add_comment::false"
-          else
-            body="👎\`Failed${results}\`"
-            body="${body//'%'/'%25'}"
-            body="${body//$'\n'/'%0A'}"
-            body="${body//$'\r'/'%0D'}"
-            body="$( echo $body | sed 's/\/home\/runner\/work\/element-android\/element-android\//\`<br\/>\`/g')"
-            body="$( echo $body | sed 's/\/src\/main\/java\// 🔸 /g')"
-            body="$( echo $body | sed 's/im\/vector\/app\///g')"
-            body="$( echo $body | sed 's/im\/vector\/lib\/attachmentviewer\///g')"
-            body="$( echo $body | sed 's/im\/vector\/lib\/multipicker\///g')"
-            body="$( echo $body | sed 's/im\/vector\/lib\///g')"
-            body="$( echo $body | sed 's/org\/matrix\/android\/sdk\///g')"
-            body="$( echo $body | sed 's/\/src\/androidTest\/java\// 🔸 /g')"
-            echo "::set-output name=add_comment::true"
-            echo "::set-output name=body::$body"
-          fi
-      - name: Find Comment
-        if: always() && github.event_name == 'pull_request'
-        uses: peter-evans/find-comment@v2
-        id: fc
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          comment-author: 'github-actions[bot]'
-          body-includes: Ktlint Results
-      - name: Add comment if needed
-        if: always() && github.event_name == 'pull_request' && steps.ktlint-results.outputs.add_comment == 'true'
-        uses: peter-evans/create-or-update-comment@v2
-        with:
-          comment-id: ${{ steps.fc.outputs.comment-id }}
-          issue-number: ${{ github.event.pull_request.number }}
-          body: |
-            ### Ktlint Results
-
-            ${{ steps.ktlint-results.outputs.body }}
-          edit-mode: replace
-      - name: Delete comment if needed
-        if: always() && github.event_name == 'pull_request' && steps.fc.outputs.comment-id != '' && steps.ktlint-results.outputs.add_comment == 'false'
-        uses: actions/github-script@v3
+          npm install --save-dev @babel/core
+          npm install --save-dev @babel/plugin-transform-flow-strip-types
+          yarn add danger-plugin-lint-report --dev
+      - name: Danger lint
+        if: always()
+        uses: danger/[email protected]
         with:
-          script: |
-            github.issues.deleteComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              comment_id: ${{ steps.fc.outputs.comment-id }}
-            })
+          args: "--dangerfile tools/danger/dangerfile-lint.js"
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}
 
   # Gradle dependency analysis using https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin
   dependency-analysis:
@@ -122,107 +92,3 @@ jobs:
         with:
           name: dependency-analysis
           path: build/reports/dependency-check-report.html
-
-  # Lint for main module
-  android-lint:
-    name: Android Linter
-    runs-on: ubuntu-latest
-    # Allow all jobs on main and develop. Just one per PR.
-    concurrency:
-      group: ${{ github.ref == 'refs/heads/main' && format('android-lint-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('android-lint-develop-{0}', github.sha) || format('android-lint-{0}', github.ref) }}
-      cancel-in-progress: true
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
-          restore-keys: |
-            ${{ runner.os }}-gradle-
-      - name: Lint analysis
-        run: ./gradlew clean :vector:lint --stacktrace $CI_GRADLE_ARG_PROPERTIES
-      - name: Upload reports
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: lint-report
-          path: |
-            vector/build/reports/*.*
-
-  # Lint for Gplay and Fdroid release APK
-  apk-lint:
-    name: Lint APK (${{ matrix.target }})
-    runs-on: ubuntu-latest
-    if: github.ref != 'refs/heads/main'
-    strategy:
-      fail-fast: false
-      matrix:
-        target: [ Gplay, Fdroid ]
-    # Allow all jobs on develop. Just one per PR.
-    concurrency:
-      group: ${{ github.ref == 'refs/heads/develop' && format('apk-lint-develop-{0}-{1}', matrix.target, github.sha) || format('apk-lint-{0}-{1}', matrix.target, github.ref) }}
-      cancel-in-progress: true
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
-          restore-keys: |
-            ${{ runner.os }}-gradle-
-      - name: Lint ${{ matrix.target }} release
-        run: ./gradlew clean lint${{ matrix.target }}Release --stacktrace $CI_GRADLE_ARG_PROPERTIES
-      - name: Upload ${{ matrix.target }} linting report
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: release-lint-report-${{ matrix.target }}
-          path: |
-            vector/build/reports/*.*
-
-  detekt:
-    name: Detekt Analysis
-    runs-on: ubuntu-latest
-    # Allow all jobs on main and develop. Just one per PR.
-    concurrency:
-      group: ${{ github.ref == 'refs/heads/main' && format('detekt-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('detekt-develop-{0}', github.sha) || format('detekt-{0}', github.ref) }}
-      cancel-in-progress: true
-    steps:
-      - uses: actions/checkout@v3
-      - name: Run detekt
-        run: |
-          ./gradlew detekt $CI_GRADLE_ARG_PROPERTIES
-      - name: Upload reports
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: detekt-report
-          path: |
-            */build/reports/detekt/detekt.html
-
-#  towncrier:
-#    name: Towncrier check
-#    runs-on: ubuntu-latest
-#    if: github.event_name == 'pull_request' && github.head_ref == 'develop'
-#    steps:
-#      - uses: actions/checkout@v3
-#      - name: Set up Python 3.8
-#        uses: actions/setup-python@v4
-#        with:
-#          python-version: 3.8
-#      - name: Install towncrier
-#        run: |
-#          python3 -m pip install towncrier
-#      - name: Run towncrier
-#        # Fetch the pull request' base branch so towncrier will be able to
-#        # compare the current branch with the base branch.
-#        # Source: https://github.com/actions/checkout/#fetch-all-branches.
-#        run: |
-#          git fetch --no-tags origin +refs/heads/${BASE_BRANCH}:refs/remotes/origin/${BASE_BRANCH}
-#          towncrier check --compare-with origin/${BASE_BRANCH}
-#      env:
-#        BASE_BRANCH: ${{ github.base_ref }}

.gitignore

@@ -17,3 +17,8 @@
 /fastlane/report.xml
 
 /**/build
+
+# Added by yarn
+/package.json
+/yarn.lock
+/node_modules

Gemfile

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
 gem "fastlane"
+gem 'danger'

Gemfile.lock

@@ -24,10 +24,29 @@ GEM
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
     colored (1.2)
     colored2 (3.1.2)
     commander (4.6.0)
       highline (~> 2.0.0)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.6.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
     declarative (0.0.20)
     digest-crc (0.6.3)
       rake (>= 12.0.0, < 14.0.0)
@@ -52,6 +71,8 @@ GEM
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
+    faraday-http-cache (2.4.0)
+      faraday (>= 0.8)
     faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
@@ -98,6 +119,8 @@ GEM
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
     gh_inspector (1.1.3)
+    git (1.11.0)
+      rchardet (~> 1.8)
     google-apis-androidpublisher_v3 (0.8.0)
       google-apis-core (>= 0.4, < 2.a)
     google-apis-core (0.4.0)
@@ -143,17 +166,28 @@ GEM
     jmespath (1.4.0)
     json (2.5.1)
     jwt (2.2.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     memoist (0.16.2)
     mini_magick (4.11.0)
     mini_mime (1.1.0)
     multi_json (1.15.0)
     multipart-post (2.0.0)
     nanaimo (0.3.0)
+    nap (1.1.0)
     naturally (2.2.1)
+    no_proxy_fix (0.1.2)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
     os (1.1.1)
     plist (3.6.0)
     public_suffix (4.0.6)
     rake (13.0.6)
+    rchardet (1.8.0)
     representable (3.1.1)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
@@ -163,6 +197,9 @@ GEM
     rouge (2.0.7)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
     security (0.1.3)
     signet (0.15.0)
       addressable (~> 2.3)
@@ -200,9 +237,11 @@ GEM
       xcpretty (~> 0.2, >= 0.0.7)
 
 PLATFORMS
+  universal-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
+  danger
   fastlane
 
 BUNDLED WITH

build.gradle

@@ -126,6 +126,11 @@ allprojects {
         enableExperimentalRules = true
         // display the corresponding rule
         verbose = true
+        reporters {
+            reporter(org.jlleitschuh.gradle.ktlint.reporter.ReporterType.PLAIN)
+            // To have XML report for Danger
+            reporter(org.jlleitschuh.gradle.ktlint.reporter.ReporterType.CHECKSTYLE)
+        }
         disabledRules = [
                 // TODO Re-enable these 4 rules after reformatting project
                 "indent",

changelog.d/6637.misc

@@ -0,0 +1 @@
+Setup Danger to the project