External issues report deprecated format

SonarQube Cloud
1

Hello!

  • ALM: Gitlab
  • CI system: GitlabCI

In a Gitlab pipeline job I am exporting an external issues report to SonarCloud using the sonar.externalIssuesReportPaths as per the documentation suggests.

When reviewing the job’s output I can see the following:

External issues were imported with a deprecated format which will be removed soon. Please switch to the newest format to fully benefit from Clean Code: https://docs.sonarcloud.io/enriching/generic-issue-data/

I followed the link in order to check and update my report accordingly to the “new” format. However, reviewing the documentation of the link provided I noted that the format is exactly the same as the one I already export.

Report being exported to SonarCloud:

{
  "issues": [
    {
      "engineId": "engine-example",
      "ruleId": "rule-example",
      "severity": "MAJOR",
      "type": "VULNERABILITY",
      "primaryLocation": {
        "message": "MAJOR level vulnerability in Saxon-HE-12.2.jar",
        "filePath": "build.gradle",
        "textRange": {
          "startLine": 1
        }
      }
    } 
  ]
}

Example report showed in the documentation:

{ "issues": [
    {
      "engineId": "test",
      "ruleId": "rule1",
      "severity":"BLOCKER",
      "type":"CODE_SMELL",
      "primaryLocation": {
        "message": "fully-fleshed issue",
        "filePath": "sources/A.java",
        "textRange": {
          "startLine": 30,
          "endLine": 30,
          "startColumn": 9,
          "endColumn": 14
        }
      },
      "effortMinutes": 90,
      "secondaryLocations": [
        {
          "message": "cross-file 2ndary location",
          "filePath": "sources/B.java",
          "textRange": {
            "startLine": 10,
            "endLine": 10,
            "startColumn": 6,
            "endColumn": 38
          }
        }
      ]
    },
    {
      "engineId": "test",
      "ruleId": "rule2",
      "severity": "INFO",
      "type": "BUG",
      "primaryLocation": {
        "message": "minimal issue raised at file level",
        "filePath": "sources/Measure.java"
      }
    }
]}

Has the documentation not been updated yet? Where can I find the new format?

Thanks in advance

9

Hey @CuiMaldonado

It looks like we released a new version of the format, decided it wasn’t quite done yet, pulled the documentation but didn’t pull the warning message. The new (improved) version should go live next week, and we’ll update the documentation then.

Sorry about the trouble!

13

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.