Add gitlab codequality format by Avihais12344 · Pull Request #741 · adrienverge/yamllint

Avihais12344 · 2025-04-18T19:57:24Z

Added codequality format as specified at the docs, with tests.

Please merge this for all the Gitlab users!

coveralls · 2025-04-18T20:19:26Z

coverage: 99.817% (+0.002%) from 99.815%
when pulling df38c11 on Avihais12344:feature/add-gitlab-codequality-format
into e3d54cc on adrienverge:master.

Avihais12344 · 2025-04-22T17:01:48Z

Can someone please review and accept this PR?
@adrienverge

Avihais12344 · 2025-04-24T20:17:59Z

Fixes #743

Avihais12344 · 2025-04-29T09:52:41Z

Please someone approve this.
@adrienverge

adrienverge · 2025-04-29T12:09:14Z

Please be patient.

Avihais12344 · 2025-05-07T07:10:16Z

Is there any news on this?
@adrienverge

adrienverge · 2025-05-07T07:21:20Z

Stop harassing me. I'll look at it when I can. It can be in months.

Avihais12344 · 2025-07-07T05:36:08Z

It's been months, I am back.
Any news @adrienverge ?

Avihais12344 · 2025-07-07T05:37:41Z

Maybe even @koyuki7w ?

Avihais12344 · 2025-07-24T20:47:05Z

It's not that big, please let's finish this:
@adrienverge @koyuki7w

freehck · 2025-07-29T23:17:29Z

@Avihais12344
You already did all the work but gotta wait for eternity to have your stuff in upstream? Welcome to the FOSS! =)

Believe me it's still not so long. Once upon time in one python project I've been waiting for several years, and eventually found the authors decided to rewrite the code from scratch dumping all the work done.

So be patient man. Be patient. =)

Avihais12344 · 2025-07-30T03:41:34Z

@freehck
I see, thanks for your advice.
But what would you do in this situation?

freehck · 2025-07-30T17:34:12Z

@Avihais12344
I'd use the fork until PR's merged.
Somethig like this:
pip install git+https://github.com/freehck/yamllint.git@my-master

DimitriPapadopoulos

I would recommend using single quotes (in Python code) for consistency.

DimitriPapadopoulos · 2025-09-07T04:35:14Z

yamllint/cli.py

        if ('GITHUB_ACTIONS' in os.environ and
                'GITHUB_WORKFLOW' in os.environ):
            args_format = 'github'
+        elif ("GITLAB_CI" in os.environ):


👍 GITLAB_CI indeed appears to be the best way to detect jobs executed in GitLab CI/CD:

Predefined variables

Thank you so much.
So I can resolve this conversation right?

docs/quickstart.rst

DimitriPapadopoulos · 2025-09-07T04:58:47Z

yamllint/cli.py

+                        "begin": problem.line,
+                        "end": problem.line,


From JSON linting best practices:

For numerical values, quotes are optional but it is a good idea to enclose them in double quotes.

Not sure about this one: quotes are optional, but would it be a "good idea" to add quotes as suggested?

I understand you'd have to cast with str() as is the case for the hash above.

Done.
What do you think @DimitriPapadopoulos? Added a comment so people would understand why I have did it.

Well, why not?

DimitriPapadopoulos · 2025-09-07T05:13:11Z

yamllint/cli.py

+                first = False
+            else:
+                print(",")
+            print(textwrap.indent(Format.gitlab(problem, file), "  "), end='')


Why indent here and not in Format.gitlab? Both are possible of course. Is there a rational behind your choice?

The JSON finalization is made here (print of "[", "]", "," between blocks), so I think he wanted to keep that final formatting here, and Format.gitlab to only return a JSON block ready to be inserted in the final output

That's right @EzLucky, I can solve this conversation now @DimitriPapadopoulos ?

Co-authored-by: Dimitri Papadopoulos Orfanos <[email protected]>

Avihais12344 · 2025-09-18T18:39:43Z

I would recommend using single quotes (in Python code) for consistency.

Fixed.

Avihais12344 · 2025-09-18T18:40:03Z

@Avihais12344 I'd use the fork until PR's merged. Somethig like this: pip install git+https://github.com/freehck/yamllint.git@my-master

Thanks for your suggestion, I would take that into account. Although it's missing the gitlab format...

…b-codequality-format

Avihais12344 · 2025-09-18T18:52:39Z

@DimitriPapadopoulos @EzLucky I would like your review again please :)

DimitriPapadopoulos · 2025-09-18T19:16:15Z

This PR looks in good shape. @adrienverge When you have time, I think it would be worth reviewing and eventually merging it.

EzLucky

Please modify in docs/integration.rst line 53 :

You can use the following GitLab CI/CD stage to run yamllint and get the
results as a `Code quality (Code Climate)
<https://docs.gitlab.com/ee/ci/testing/code_quality.html>`_ report.

to :

yamllint auto-detects when it's running inside of a GitLab CI/CD job
and automatically uses the suited output format to get the
results as a `Code quality (Code Climate)<https://docs.gitlab.com/ee/ci/testing/code_quality.html>`_ report.
You can also force GitLab Code quality output with ``yamllint --format gitlab``.

You can use the following GitLab CI/CD stage to otain a codequality report artifact:

(I can use the suggestion feature on this part of the file)

EzLucky · 2025-09-19T09:16:13Z

docs/integration.rst

     - mkdir reports
-     - >
-       yamllint -f parsable . | tee >(awk '
-       BEGIN {FS = ":"; ORS="\n"; first=1}
-       {
-           gsub(/^[ \t]+|[ \t]+$|"/, "", $4);
-           match($4, /^\[(warning|error)\](.*)\((.*)\)$/, a);
-           sev = (a[1] == "error" ? "major" : "minor");
-           if (first) {
-               first=0;
-               printf("[");
-           } else {
-               printf(",");
-           }
-           printf("{\"location\":{\"path\":\"%s\",\"lines\":{\"begin\":%s,"\
-                  "\"end\":%s}},\"severity\":\"%s\",\"check_name\":\"%s\","\
-                  "\"categories\":[\"Style\"],\"type\":\"issue\","\
-                  "\"description\":\"%s\"}", $1, $2, $3, sev, a[3], a[2]);
-       }
-       END { if (!first) printf("]\n"); }' > reports/codequality.json)
+     - yamllint -f gitlab . > codequality.json)
   artifacts:
     when: always
-     paths:
-       - reports
     expire_in: 1 week
     reports:
       codequality: reports/codequality.json


Suggestions :

simplification : the reports directory is not needed

typo : there was an extra ')'

use of tee command to display output on the terminal

renaming of the output json as you may have codequality reports from other tools in your pipeline artifacts

Suggested change

- mkdir reports

- >

yamllint -f parsable . | tee >(awk '

BEGIN {FS = ":"; ORS="\n"; first=1}

{

gsub(/^[ \t]+|[ \t]+$|"/, "", $4);

match($4, /^\[(warning|error)\](.*)$(.*)$$/, a);

sev = (a[1] == "error" ? "major" : "minor");

if (first) {

first=0;

printf("[");

} else {

printf(",");

}

printf("{\"location\":{\"path\":\"%s\",\"lines\":{\"begin\":%s,"\

"\"end\":%s}},\"severity\":\"%s\",\"check_name\":\"%s\","\

"\"categories\":[\"Style\"],\"type\":\"issue\","\

"\"description\":\"%s\"}", $1, $2, $3, sev, a[3], a[2]);

}

END { if (!first) printf("]\n"); }' > reports/codequality.json)

- yamllint -f gitlab . > codequality.json)

artifacts:

when: always

paths:

- reports

expire_in: 1 week

reports:

codequality: reports/codequality.json

- yamllint -f gitlab . | tee yamllint-codequality.json

artifacts:

when: always

expire_in: 1 week

reports:

codequality: yamllint-codequality.json

DimitriPapadopoulos · 2025-09-19T16:52:33Z

yamllint auto-detects when it's running inside of a GitLab CI/CD job
and automatically uses the suited output format to get the
results as a `Code quality (Code Climate)<https://docs.gitlab.com/ee/ci/testing/code_quality.html>`_ report.
You can also force GitLab Code quality output with ``yamllint --format gitlab``.

Or even simpler:

yamllint auto-detects when it's running inside of a GitLab CI/CD job and outputs the results as
a `Code Quality (CodeClimate)<https://docs.gitlab.com/ee/ci/testing/code_quality.html>`_ report.
You can also force GitLab Code Quality output with ``yamllint --format gitlab``.

…ample and rephrased the documentation itself to actually expain the capabilities.

Avihais12344 · 2025-09-20T18:59:39Z

Thanks for your suggestions @DimitriPapadopoulos and @EzLucky, I have tried to merge your 2 excellent suggestions.

Avihais12344 · 2025-09-25T10:06:29Z

@DimitriPapadopoulos I would like your approval as well.

@adrienverge When you can, please merge.

DimitriPapadopoulos · 2025-09-25T11:44:45Z

LGTM, and an addition worth the additional complexity as far as I'm concerned.

But the this is up to the maintainer and I know he's quite busy. Please be patient.

Avihais12344 · 2025-11-30T16:53:15Z

@adrienverge Just reminding.

Avihais12344 · 2026-01-03T13:57:35Z

@adrienverge Just reminding, and happy new year :)

Avihais12344 added 18 commits April 18, 2025 12:05

Added format testing for the gitlab format.

b38c1b5

Added test for autodetecting gitlab CI.

cae1e08

Added gitlab line format function.

5fa21fb

Added the gitlab option.

48f958f

Added auto detection in gitlab.

36b28ab

Removed unecessary cleanups.

aba4417

Removed the indent argument from the gitlab format.

4e1a86f

Added the gitlab format impel.

e0ae163

Removed unecessary spaces.

4337722

Fixed tests.

3a1e7e4

Fixed other test with same fix.

656cf79

Fixed implementation details.

e0ba928

Fixed test on warning.

17960f8

Fixed formatting.

1339997

Fixed linter error.

10473ac

Removed whitespaces.

35d23a8

Removed lines that are too long.

19abd6c

Updated env to gitlab ci.

b2ffa08

Added how to use the gitlab format.

8846590

Avihais12344 mentioned this pull request Apr 24, 2025

Add gitlab codequality format #743

Open

Merge branch 'master' into feature/add-gitlab-codequality-format

d4da64e

DimitriPapadopoulos reviewed Sep 7, 2025

View reviewed changes

Avihais12344 and others added 4 commits September 18, 2025 21:23

Removed gitlab option from quickstart.

912e668

Co-authored-by: Dimitri Papadopoulos Orfanos <[email protected]>

Fixed gitlab format to the best parctice.

d387aa1

Fixed line too long.

0e09964

Moved from " to '.

98be75f

Avihais12344 added 3 commits September 18, 2025 21:43

Merge remote-tracking branch 'upstream/master' into feature/add-gitla…

1d6f97f

…b-codequality-format

Orginized imports.

4c4b803

Fixed the integration docs for gitlab.

0a1b773

EzLucky suggested changes Sep 19, 2025

View reviewed changes

Updated the gitlab's integration docs one again, fixed the CI code ex…

b9d2a16

…ample and rephrased the documentation itself to actually expain the capabilities.

Avihais12344 requested review from DimitriPapadopoulos and EzLucky September 20, 2025 18:59

Avihais12344 added 2 commits September 20, 2025 22:01

Fixed linting problems.

0a4dee2

Fixed another linting error with link.

df38c11

EzLucky approved these changes Sep 20, 2025

View reviewed changes

Comments

Conversation

Avihais12344 commented Apr 18, 2025

Uh oh!

coveralls commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Avihais12344 commented Apr 22, 2025

Uh oh!

Avihais12344 commented Apr 24, 2025

Uh oh!

Avihais12344 commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adrienverge commented Apr 29, 2025

Uh oh!

Avihais12344 commented May 7, 2025

Uh oh!

adrienverge commented May 7, 2025

Uh oh!

Avihais12344 commented Jul 7, 2025

Uh oh!

Avihais12344 commented Jul 7, 2025

Uh oh!

Avihais12344 commented Jul 24, 2025

Uh oh!

freehck commented Jul 29, 2025

Uh oh!

Avihais12344 commented Jul 30, 2025

Uh oh!

freehck commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DimitriPapadopoulos left a comment

Choose a reason for hiding this comment

Uh oh!

DimitriPapadopoulos Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Avihais12344 Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DimitriPapadopoulos Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Avihais12344 Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

DimitriPapadopoulos Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

DimitriPapadopoulos Sep 7, 2025

Choose a reason for hiding this comment

Uh oh!

EzLucky Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

Avihais12344 Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Avihais12344 commented Sep 18, 2025

Uh oh!

Avihais12344 commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Avihais12344 commented Sep 18, 2025

Uh oh!

DimitriPapadopoulos commented Sep 18, 2025

Uh oh!

EzLucky left a comment

Choose a reason for hiding this comment

Uh oh!

EzLucky Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

DimitriPapadopoulos commented Sep 19, 2025

Uh oh!

coveralls commented Apr 18, 2025 •

edited

Loading

Avihais12344 commented Apr 29, 2025 •

edited

Loading

freehck commented Jul 30, 2025 •

edited

Loading

DimitriPapadopoulos Sep 7, 2025 •

edited

Loading

DimitriPapadopoulos Sep 7, 2025 •

edited

Loading

Avihais12344 commented Sep 18, 2025 •

edited

Loading