Awesome

There are very few users of this tool, so I am archiving it and referring to:

• https://github.com/tomasbjerre/violation-comments-to-gitlab-command-line
• https://github.com/jenkinsci/violation-comments-to-gitlab-plugin/
• https://github.com/tomasbjerre/violations-command-line

Violation Comments to GitLab Gradle Plugin

This is a Gradle plugin for Violation Comments to GitLab Lib.

It can parse results from static code analysis and comment merge requests in GitLab with them.

An alternative is also to have violations-command-line convert the violations to CodeClimate format and upload that to GitLab. It is explained in readme of violations-command-line.

The merge must be performed first in order for the commented lines in the MR to match the lines reported by the analysis tools!

Example of supported reports are available here.

A number of parsers have been implemented. Some parsers can parse output from several reporters.

Missing a format? Open an issue here!

Usage

There is a running example here and it is invoked here.

Here is and example:

buildscript {
 repositories {
  maven { url 'https://plugins.gradle.org/m2/' }
 }
 dependencies {
  classpath "se.bjurr.violations:violation-comments-to-gitlab-gradle-plugin:X"
 }
}

apply plugin: "se.bjurr.violations.violation-comments-to-gitlab-gradle-plugin"

task violationCommentsToGitLab(type: se.bjurr.violations.comments.gitlab.plugin.gradle.ViolationCommentsToGitLabTask) {
 gitLabUrl = System.properties['GITLAB_URL'];
 mergeRequestIid = System.properties['GITLAB_MERGEREQUESTIID'];
 projectId = System.properties['GITLAB_PROJECTID'];

 commentOnlyChangedContent = true;
 commentOnlyChangedContentContext = 0;
 createCommentWithAllSingleFileComments = true;
 createSingleFileComments = true;
 keepOldComments = false;
 minSeverity = "INFO";
 maxNumberOfComments = 99999;
 //commentTemplate = """
 // See https://github.com/tomasbjerre/violation-comments-lib
 //""" 

 apiTokenPrivate = true;
 apiToken = System.properties['GITLAB_APITOKEN'];
 ignoreCertificateErrors = true;

 shouldSetWip = false;
 
 //proxyServer = ""
 //proxyUser = ""
 //proxyPassword = ""
 
 violations = [
  ["FINDBUGS",   ".", ".*/findbugs/.*\\.xml\$",   "Findbugs"],
  ["PMD",        ".", ".*/pmd/.*\\.xml\$",        "PMD"],
  ["CHECKSTYLE", ".", ".*/checkstyle/.*\\.xml\$", "Checkstyle"],
  ["JSHINT",     ".", ".*/jshint/.*\\.xml\$",     "JSHint"],
  ["CSSLINT",    ".", ".*/csslint/.*\\.xml\$",     "CssLint"]
 ]
}

You may also have a look at Violations Lib.

Developer instructions

To build the code you need to run build.sh in root of repo. You may also have a look at .travis.yml.

To do a release you need to do ./gradlew release -Dgradle.publish.key=... -Dgradle.publish.secret=... and release the artifact from staging. More information here.