Skip to content

Enable some extra CI features

Adam Coldrick requested to merge sotk/ci/extra-features into master

Before raising this MR, consider whether the following are required, and complete if so:

  • Unit tests
  • Metrics
  • Documentation update(s)

None required, this is CI configuration changes only.

Description

This MR updates the lint job in CI to generate a JSON file in the format expected by GitLab, and adds it as a Code Quality report. This allows GitLab to display linting results in the UI in three places; a full report on the pipeline page, a summary on the related MR overview, and marked inline in the diff of the related MR. This makes it easier to see lint issues when the tests fail, rather than looking in the CI logs.

This MR also updates the coverage job to generate an XML report and add it as a coverage report for GitLab to use. This causes GitLab to decorate the diff of the related MR with coverage information, making it clear where test coverage is lacking in new code.

This MR is ready for review, but currently contains a demonstration commit to show these feature's in it's diff. This commit will need to be removed before it can be merged, so that the lint job can pass again.

Validation

View the diff of this MR to see the features in action. The pipeline run and code quality summary on the overview tab of this MR are also worth looking at.

Edited by Adam Coldrick

Merge request reports