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.

MISRA Compliance Report Plugin

misraReport: Build MISRA Guideline Compliance Summary (GCS)

  • doFailOnError (optional)
    Fail the build if the plugin could not create a valid MISRA Guideline Compliance Summary.
    • Type: boolean
  • doFailOnIncompliance (optional)
    Fail the build if the result of the Guideline Compliance Report is that the code is not MISRA-compliant.
    • Type: boolean
  • grpFile (optional)

    A simple text file containing the guideline re-categorization plan (GRP) - see "MISRA Compliance 2016". Leave empty to not re-categorize any rules. Rules that are not recategorized do not need to appear in this listing.

    The format of the text file should be:
    [Guideline], [New compliance level]
    Directive 1.1, Mandatory
    Rule 11.2, Mandatory
    Rule 12.1, Required
    Rule 12.2, Disapplied

    • Type: String
  • logFile (optional)
    The log file will list all the tags discovered in the code. The file can be parsed by a warning parser. A typical use would be to automatically add comments or review tasks to a pull request. The output format is the same as the clang compiler.
    • Type: String
  • nonMisraTagPattern (optional)
    • Type: String
  • projectName (optional)
    Project name to be shown in the report
    • Type: String
  • ruleSet (optional)
    Select the version of MISRA guidelines to be applied
    • Type: String
  • softwareVersion (optional)
    The software version to show in the report. Usually you would use an environment variable which has been set by one of the earlier build steps here, e. g. ${SOFTWARE_VERSION}
    • Type: String
  • sourceListFile (optional)
    A file containing a list of source code and header files separated by newlines. These files will be checked for suppressing comments and tags.
    • Type: String
  • warningParser (optional)
    Select the tool used to check for code compliance.
    • Type: String
  • warningsFile (optional)
    File that contains warnings produced by the warning parser.
    • Type: String

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.