1705333 - [Automated review] reviewbot spam about updated documentation

Status: NEW

(Firefox Build System :: Task Configuration, defect, P3)

Description

[Lars T Hansen [:lth]]

+++ This bug was initially created as a clone of Bug #1667506 +++

I'm receiving a lot of notifications about "updated documentation" and the messages appear to be largely incorrect and irrelevant. This seems to have gotten bad recently.

Consider https://phabricator.services.mozilla.com/D111230. It is true that this patch adds a new function in a third_party/rust crate that has a doc comment and may thus be considered new "documentation", but for the life of me I can't find this documentation anywhere in the pages linked to from the email that I receive. Searching for the function's name or the crate's name yield nothing; after that it seems pointless.

Comment 1

[Marco Castelluccio [:marco]]

The documentation is considered to be updated whenever a .rst or .md file changes (https://searchfox.org/mozilla-central/rev/0b90e582d2f592a30713bafc55bfeb0e39e1a1fa/moz.build#62-66), and js/src/jit-test/tests/wasm/spec/README.md changed in the revision stack (in https://phabricator.services.mozilla.com/D111227, which https://phabricator.services.mozilla.com/D111230 depends on).

I'm not sure why source-test-doc-upload was scheduled on https://treeherder.mozilla.org/jobs?repo=try&revision=76584b41e2b9ed29bb5cc6bc0843723cc87a7df3, but source-test-doc-generate wasn't (even though they have the same optimization set).

Comment 2

[Andrew Halberstadt [:ahal]]

Looks like source-test-doc-upload is in the target tasks but source-test-doc-gen is not:
https://firefoxci.taskcluster-artifacts.net/ZKidM3VrTZS11SwTWKn__w/0/public/target-tasks.json

I'm not sure why that's the case, how is reviewbot pushing to try? (hg.m.o is timing out so I can't inspect the revision atm..)

I guess we should make upload depend on gen so this can't happen.

Comment 3

[Marco Castelluccio [:marco]]

(In reply to Andrew Halberstadt [:ahal] from comment #2)

Looks like source-test-doc-upload is in the target tasks but source-test-doc-gen is not:
https://firefoxci.taskcluster-artifacts.net/ZKidM3VrTZS11SwTWKn__w/0/public/target-tasks.json

I'm not sure why that's the case, how is reviewbot pushing to try? (hg.m.o is timing out so I can't inspect the revision atm..)

I guess we should make upload depend on gen so this can't happen.

It's writing this as a try_task_config.json: https://github.com/mozilla/libmozevent/blob/648b3afe49c2dd785bfbb3c846cc81faf47ab487/libmozevent/mercurial.py#L201-L208.

The target tasks are defined at https://searchfox.org/mozilla-central/rev/a8b75e4ba3f8ddf0e76b42681d0a7b7e78e67730/taskcluster/taskgraph/target_tasks.py#1192.

So I guess this happened because the upload task has the code-review attribute set to true, while the generate task doesn't.

Comment 4

[Andrew Halberstadt [:ahal]]

Sorry.. I totally forgot that the upload task also generates the docs. The gen one is only useful for testing, so everything is working as expected.

Comment 5

[Marco Castelluccio [:marco]]

OK, so I guess there are two problems here:

• the rules to run the docs tasks are too broad, js/src/jit-test/tests/wasm/spec/README.md shouldn't trigger it;
• the file was changed in the Phabricator stack, but not in https://phabricator.services.mozilla.com/D111230 specifically. Bug 1637583 would fix this (as it would fix bug 1667506).