1807831 - Add a check to make sure that we don't regress the number of warnings

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, task)

Description

[Sylvestre Ledru [:Sylvestre]]

We have currently many warnings (3841 today).

Maybe we should store this number in a configuration file ( docs/config.yml ?) and make sure it doesn't go above.

The number of warnings can be found in the log. Example:
https://firefoxci.taskcluster-artifacts.net/F-wVIWdBSzCNQvWWvCwAdA/0/public/logs/live_backing.log

build succeeded, .* warnings.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

a more recent one:
https://firefoxci.taskcluster-artifacts.net/TMp_0MVOTTeSg-8oQR7YbA/0/public/logs/live_backing.log
[task 2023-01-18T10:03:15.179Z] build succeeded, 3718 warnings.

Comment 2

[Sylvestre Ledru [:Sylvestre]]

this can probably be done next to:
https://searchfox.org/mozilla-central/source/tools/moztreedocs/mach_commands.py#173-179

Comment 3

[cdengler]

Recap of the discussion of the specs in the chat

• we put some upper bound X on the acceptable number of warnings in the config file
• if a user submits a change that raises more warnings than the upper bound, the build fails
• the user is told their changes raised N - X = Y new warnings, and that they should review them

I'd add a new flag --check-num-warnings, is that name OK for you?

Comment 4

[Sylvestre Ledru [:Sylvestre]]

sounds good, thanks

Comment 5

[cdengler]

Attachment: Bug 1807831 - Add a check to make sure that we don't regress the number of warnings r=sylvestre

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8b332f84762b
Add a check to make sure that we don't regress the number of warnings r=sylvestre,ahal DONTBUILD

Comment 7

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/8b332f84762b

Comment 8

[ogiorgis]

Attachment: Bug 1807831 - Add check-num-warnings option to the ci r=#firefox-source-docs-reviewers

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e60526f1b822
Add check-num-warnings option to the ci r=firefox-source-docs-reviewers,sylvestre DONTBUILD

Comment 10

[Serban Stanca [:SerbanS]]

Backed out for causing documentation failures.

• Backout link
• Push with failures
• Failure Log

Comment 11

[ogiorgis]

Attachment: Bug 1807831 - Add check-num-warnings option to the ci r=#firefox-source-docs-reviewers

Comment 12

[BugBot [:suhaib / :marco]]

A patch has been attached on this bug, which was already closed. Filing a separate bug will ensure better tracking. If this was not by mistake and further action is needed, please alert the appropriate party. (Or: if the patch doesn't change behavior -- e.g. landing a test case, or fixing a typo -- then feel free to disregard this message)

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f795d3557239
Add check-num-warnings option to the ci r=firefox-source-docs-reviewers,sylvestre DONTBUILD

Comment 14

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/f795d3557239