Danger #6637

bmarty · 2022-07-25T15:50:25Z

This PR add Danger to the project. Please refer to the documentation included in this PR (rendered) for more detail about the tool itself.

Other changes:
quality.xml has been updated, because all commands that generate XML report must be run before Danger can use them to generate PR comments.

Once merged, the list of required GitHub action will have to be updated on GitHub.

Check with main dangerfile

Example of comment made by this check:

Check with lint

Examples of comments (first error from ktlint, second error from Detekt):

And comment example from lint:

bmarty · 2022-07-27T14:19:28Z

.github/workflows/quality.yml

        if: always()
-        id: ktlint-results


This is not necessary anymore, since Danger will post comments for each detected ktlint issue

bmarty · 2022-07-28T09:19:48Z

For commit b0e019e

It was because we had this comment:

I do not know why this lint warning was reported, and not the 600+ other lint warnings.

bmarty · 2022-07-28T14:23:16Z

.github/workflows/quality.yml

          path: |
-            */build/reports/ktlint/ktlint*/ktlint*.txt
-      - name: Handle Results
+            */build/reports/**/*.*


All reports are correctly exported, see https://github.com/vector-im/element-android/actions/runs/2753115871

So that Danger can report all errors from generated XML files

… 2 steps

…since this is a warning. Also make this issue an error.

See https://github.com/Kotlin/kotlinx-knit#tasks

michaelkaye

It looks like it does the right things; I'm just a little concerned that https://github.com/vector-im/element-android/runs/7558101014?check_suite_focus=true#step:5:10 means we don't have the right accounts set up on it.

Found no issues or messages from Danger. Removing any existing messages on GitHub.
Could not add a commit status, the GitHub token for Danger does not have access rights.
If the build fails, then danger will use a failing exit code.

After merge would be good to see how 3rd party contributors see the requests - if they don't have the secret they might miss out on the danger report.

sonarcloud · 2022-07-29T09:35:09Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

ouchadam · 2022-07-29T10:31:50Z

.github/workflows/danger.yml

+    steps:
+      - uses: actions/checkout@v3
+      - run: |
+          npm install --save-dev @babel/plugin-transform-flow-strip-types


is @babel/plugin-transform-flow-strip-types mandatory to run danger? I'm wondering if there's a local package.json/babel config we should apply this to as well 🤔

yes, without this line, I got an error, see https://github.com/vector-im/element-android/runs/7524822865 :

Run danger/danger-js@9.1.6 /usr/bin/docker run --name cd98fa901ef5630854d6b946f9faf39f02a4d_20631b --label 4cd98f --workdir /github/workspace --rm -e GITHUB_TOKEN -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e GITHUB_STEP_SUMMARY -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/element-android/element-android":"/github/workspace" 4cd98f:a901ef5630854d6b946f9faf39f02a4d Error: { Error: Cannot find module '@babel/plugin-transform-flow-strip-types' from '/github/workspace' at Function.module.exports [as sync] (/usr/src/danger/node_modules/resolve/lib/sync.js:40:15) at resolveStandardizedName (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:101:31) at resolvePlugin (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:54:10) at loadPlugin (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:62:20) at createDescriptor (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:154:9) at items.map (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:109:50) at Array.map (<anonymous>) at createDescriptors (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:109:29) at createPluginDescriptors (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:105:10) at alias (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:63:49) code: 'MODULE_NOT_FOUND' }

Actually this is more https://github.com/vector-im/element-android/runs/7526127685 :

Run danger/danger-js@11.1.1 /usr/bin/docker run --name cd98fbc3b34cafe1d46bbabf9cc41d533b8f8_c74665 --label 4cd98f --workdir /github/workspace --rm -e GITHUB_TOKEN -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e GITHUB_STEP_SUMMARY -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/element-android/element-android":"/github/workspace" 4cd98f:bc3b34cafe1d46bbabf9cc41d533b8f8 Error: Error: Cannot find module '@babel/plugin-transform-flow-strip-types' Require stack: - /usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js - /usr/src/danger/node_modules/@babel/core/lib/config/files/index.js - /usr/src/danger/node_modules/@babel/core/lib/index.js - /usr/src/danger/distribution/runner/runners/utils/transpiler.js - /usr/src/danger/distribution/runner/runners/inline.js - /usr/src/danger/distribution/commands/danger-runner.js at Function.Module._resolveFilename (internal/modules/cjs/loader.js:902:15) at resolve (internal/modules/cjs/helpers.js:107:19) at resolveStandardizedName (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:111:7) at resolvePlugin (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:55:10) at loadPlugin (/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js:63:20) at loadPlugin.next (<anonymous>) at createDescriptor (/usr/src/danger/node_modules/@babel/core/lib/config/config-descriptors.js:187:16) at createDescriptor.next (<anonymous>) at evaluateSync (/usr/src/danger/node_modules/gensync/index.js:251:28) at /usr/src/danger/node_modules/gensync/index.js:31:34 { code: 'MODULE_NOT_FOUND', requireStack: [ '/usr/src/danger/node_modules/@babel/core/lib/config/files/plugins.js', '/usr/src/danger/node_modules/@babel/core/lib/config/files/index.js', '/usr/src/danger/node_modules/@babel/core/lib/index.js', '/usr/src/danger/distribution/runner/runners/utils/transpiler.js', '/usr/src/danger/distribution/runner/runners/inline.js', '/usr/src/danger/distribution/commands/danger-runner.js' ] }

ouchadam · 2022-07-29T10:48:47Z

docs/danger.md

+To run danger locally, install it and run:
+
+```shell
+bundle exec danger pr <PR_URL> --dangerfile=./tools/danger/dangerfile.js


worth mentioning that there's 2 implementations of danger, JS and Ruby, it looks like we're using the JS version in the github action but the Ruby version locally, this could introduce differences~

yarn danger pr <PR URL>

Yes, thanks for the heads up. I'll keep that in mind for the future 👍

ouchadam

looks great! no blockers from me 💯

bmarty · 2022-07-29T10:55:21Z

Thanks for the review, let's merge the PR and see what we will get on other PRs!

bmarty force-pushed the feature/bma/danger branch 7 times, most recently from f268050 to 135df78 Compare July 27, 2022 13:14

element-hq deleted a comment from github-actions bot Jul 27, 2022

bmarty force-pushed the feature/bma/danger branch from d820222 to ebbef55 Compare July 27, 2022 14:09

bmarty commented Jul 27, 2022

View reviewed changes

bmarty force-pushed the feature/bma/danger branch 2 times, most recently from f86cc57 to 73b8460 Compare July 28, 2022 09:51

bmarty commented Jul 28, 2022

View reviewed changes

bmarty marked this pull request as ready for review July 28, 2022 14:24

bmarty requested review from stefanceriu, michaelkaye, ouchadam and ganfra July 28, 2022 14:24

bmarty and others added 10 commits July 29, 2022 10:02

We do not use TravisCI anymore.

a52a250

Setup Danger to Element Android project.

56691f6

No need for ktlint comment, Danger will inline comment

630a981

Merge jobs that generate XML reports together

a062093

So that Danger can report all errors from generated XML files

Add changelog

036521a

Gradle daemon does not stop to get killed, try to split lint check in…

b77475a

… 2 steps

Ignore PluralsCandidate, I do not know why it is reported by Danger, …

cc6dad3

…since this is a warning. Also make this issue an error.

Get all the reports, in all the formats

4d62e75

Call the correct command for knit

66fa285

See https://github.com/Kotlin/kotlinx-knit#tasks

Knit: do not check node_modules folder

fb67499

bmarty force-pushed the feature/bma/danger branch from 91fe6f9 to fb67499 Compare July 29, 2022 08:02

michaelkaye approved these changes Jul 29, 2022

View reviewed changes

ouchadam reviewed Jul 29, 2022

View reviewed changes

ouchadam approved these changes Jul 29, 2022

View reviewed changes

bmarty merged commit 59f00cd into develop Jul 29, 2022

bmarty deleted the feature/bma/danger branch July 29, 2022 10:55

bmarty mentioned this pull request Jul 29, 2022

Set up danger #5802

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Danger #6637

Danger #6637

bmarty commented Jul 25, 2022 •

edited

bmarty Jul 27, 2022

bmarty commented Jul 28, 2022 •

edited

bmarty Jul 28, 2022

michaelkaye left a comment •

edited

sonarcloud bot commented Jul 29, 2022

ouchadam Jul 29, 2022

bmarty Jul 29, 2022 •

edited

bmarty Jul 29, 2022

ouchadam Jul 29, 2022

bmarty Jul 29, 2022

ouchadam left a comment

bmarty commented Jul 29, 2022

Danger #6637

Danger #6637

Conversation

bmarty commented Jul 25, 2022 • edited

Check with main dangerfile

Check with lint

bmarty Jul 27, 2022

Choose a reason for hiding this comment

bmarty commented Jul 28, 2022 • edited

bmarty Jul 28, 2022

Choose a reason for hiding this comment

michaelkaye left a comment • edited

Choose a reason for hiding this comment

sonarcloud bot commented Jul 29, 2022

ouchadam Jul 29, 2022

Choose a reason for hiding this comment

bmarty Jul 29, 2022 • edited

Choose a reason for hiding this comment

bmarty Jul 29, 2022

Choose a reason for hiding this comment

ouchadam Jul 29, 2022

Choose a reason for hiding this comment

bmarty Jul 29, 2022

Choose a reason for hiding this comment

ouchadam left a comment

Choose a reason for hiding this comment

bmarty commented Jul 29, 2022

bmarty commented Jul 25, 2022 •

edited

bmarty commented Jul 28, 2022 •

edited

michaelkaye left a comment •

edited

bmarty Jul 29, 2022 •

edited