Add GitLab formatter #766
Merged
Add GitLab formatter #766
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sbrunner
approved these changes
May 17, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new GitLab formatter to output prospector findings in the GitLab Code Quality report format.
- Introduces a new formatter class (GitlabFormatter) in prospector/formatters/gitlab.py
- Registers the new formatter in the init.py file for available formatters
- Updates the documentation to include usage instructions for the gitlab formatter
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| prospector/formatters/gitlab.py | Adds the GitlabFormatter implementation for GitLab Code Quality |
| prospector/formatters/init.py | Registers the gitlab formatter |
| docs/usage.rst | Updates the documentation table to reference the gitlab formatter |
|
Thanks for your contribution :-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add GitLab formatter
Related Issue
#765
Motivation and Context
When running prospector on GitLab CI/CD, it is not possible to use its report as is, because GitLab uses the "CodeClimate report format", which is not supported.
How Has This Been Tested?
I tested these changes and got the expected result.
Types of changes
Checklist: