Provide metrics for code quality

ckunki commented 8 months ago

See metrics tool in github-issue-adapter: https://github.com/exasol/github-issue-adapter/pull/223

See https://sonarcloud.io/web_api

Acceptance Criteria

PK is enhanced to provide templates for CI build that

collect sonar metrics in to a file named metrics.json following the latest version of the json schema puplished https://schemas.exasol.com/project-metrics-0.1.0.json
upload the file as asset to the GitHub workflow run, similiar to scriptrelease_droid_upload_github_release_assets.yml

Nicoretti commented 8 months ago

Maybe this helps: https://sonarcloud.io/web_api/api/measures?deprecated=false

kaklakariada commented 6 months ago

After running sonar on a Maven project, it generates a report in target/sonar/report-task.txt:

organization=exasol
projectKey=com.exasol:project-keeper-root
serverUrl=https://sonarcloud.io
serverVersion=8.0.0.53397
dashboardUrl=https://sonarcloud.io/dashboard?id=com.exasol%3Aproject-keeper-root
ceTaskId=$taskId
ceTaskUrl=https://sonarcloud.io/api/ce/task?id=$taskId

When authenticated, the ceTaskUrl returns the following content:

{
    "task": {
        "id": "$id",
        "type": "REPORT",
        "componentId": "$id",
        "componentKey": "com.exasol:project-keeper-root",
        "componentName": "Project Keeper Root Project",
        "componentQualifier": "TRK",
        "analysisId": "$id",
        "status": "SUCCESS",
        "submittedAt": "2024-03-21T06:45:20+0100",
        "submitterLogin": "$user@github",
        "startedAt": "2024-03-21T06:45:21+0100",
        "executedAt": "2024-03-21T06:45:24+0100",
        "executionTimeMs": 3795,
        "logs": false,
        "hasScannerContext": true,
        "organization": "exasol",
        "warningCount": 1,
        "warnings": []
    }
}

exasol / project-keeper

Provide metrics for code quality #513

Acceptance Criteria