> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Violation Comments to GitHub Plugin

View this plugin on the Plugins site

ViolationsToGitHub: Report Violations to GitHub

See Violation Comments to GitHub Plugin for details on how to configure and use this plugin.

Pattern is a regular expression for matching report files. For example .*/findbugs/.*\.xml$ matches xml-files, in a folder named findbugs, anywhere in workspace.

  • config
      Nested Object
    • repositoryName
      • Type: String
    • repositoryOwner
      • Type: String
    • pullRequestId
      • Type: String
    • gitHubUrl
      • Type: String
    • commentOnlyChangedContent (optional)
      • Type: boolean
    • commentOnlyChangedFiles (optional)
      • Type: boolean
    • commentTemplate (optional)
      • Type: String
    • createCommentWithAllSingleFileComments (optional)
      • Type: boolean
    • createSingleFileComments (optional)
      • Type: boolean
    • credentialsId (optional)
      • Type: String
    • keepOldComments (optional)
      • Type: boolean
    • maxNumberOfViolations (optional)
      • Type: int
    • minSeverity (optional)
      • Values: INFO, WARN, ERROR
    • oAuth2Token (optional)
      • Type: String
    • violationConfigs (optional)
        Array / List of Nested Object
      • reporter
        • Type: String
      • pattern
        • Type: String
      • parser
        • Values: ANDROIDLINT, CHECKSTYLE, CODENARC, CLANG, CPD, CPPCHECK, CPPLINT, CSSLINT, GENERIC, FINDBUGS, FLAKE8, FXCOP, GENDARME, IAR, JCREPORT, JSLINT, JUNIT, LINT, KLOCWORK, KOTLINMAVEN, KOTLINGRADLE, MSCPP, MSBULDLOG, MYPY, GOLINT, GOOGLEERRORPRONE, PERLCRITIC, PITEST, PMD, PROTOLINT, PYDOCSTYLE, PYLINT, RESHARPER, SBTSCALAC, SIMIAN, SONAR, STYLECOP, XMLLINT, YAMLLINT, ZPTLINT, DOCFX, PCLINT, CODECLIMATE, XUNIT

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.