Publish linter warnings as Github PR comments

Signed-off-by: Nic Cope <negz@rk0n.org>
haarchri · Mar 7, 2019 · bb4a6d3 · bb4a6d3
1 parent 8a7a8ed
commit bb4a6d3
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -12,6 +12,8 @@ pipeline {
 
     environment {
         RUNNING_IN_CI = 'true'
+        REPOSITORY_NAME = "${env.GIT_URL.tokenize('/')[3].split('\\.')[0]}"
+        REPOSITORY_OWNER = "${env.GIT_URL.tokenize('/')[2]}"
         DOCKER = credentials('dockerhub-upboundci')
         AWS = credentials('aws-upbound-bot')
         GITHUB_UPBOUND_BOT = credentials('github-upbound-jenkins')
@@ -47,6 +49,31 @@ pipeline {
                 sh './build/run make vendor.check'
                 sh './build/run make -j\$(nproc) build.all'
             }
+            post {
+                always {
+                    archiveArtifacts "_output/lint/**/*"
+                    ViolationsToGitHub([
+                        gitHubUrl: env.GIT_URL,
+                        repositoryName: env.REPOSITORY_NAME,
+                        repositoryOwner: env.REPOSITORY_OWNER,
+                        pullRequestId: env.CHANGE_ID,
+                        oAuth2Token: env.GITHUB_UPBOUND_BOT_PSW,
+
+                        createCommentWithAllSingleFileComments: false,
+                        createSingleFileComments: true,
+                        keepOldComments: false,
+                        commentOnlyChangedContent: true,
+                        commentTemplate: readFile('hack/linter-violation.tmpl'),
+
+                        violationConfigs: [[
+                            reporter: 'make lint',
+                            parser: 'CHECKSTYLE',
+                            // This is a regex run against the absolute path of the file.
+                            pattern: '.*/_output/lint/.+/checkstyle\\.xml\$',
+                        ]]
+                    ])
+                }
+            }
         }
 
         stage('Unit Tests') {

diff --git a/build b/build
diff --git a/hack/linter-violation.tmpl b/hack/linter-violation.tmpl
@@ -0,0 +1,3 @@
+`{{violation.rule}}`: {{violation.message}}
+
+Refer to Crossplane's [coding style documentation](CONTRIBUTING.md#coding-style-and-linting) for more information.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		`{{violation.rule}}`: {{violation.message}}

		Refer to Crossplane's [coding style documentation](CONTRIBUTING.md#coding-style-and-linting) for more information.