1376393 - Update bugs (dev-doc-needed/comment) when idl files are changed or added in the tree

Status: NEW

(Developer Services :: General, task)

Description

[Florian Scholz (Open Web Docs)]

(briefly discussed this with :baku at the SF17 all-hands opening party)
(not sure where to file this – feel free to move it around)

Whenever idl files are changed or added in the tree, the related bug should 
1) at least be marked as "dev-doc-needed"
2) ideally would also include a comment mentioning which interfaces/methods/properties etc. are affected and need doc updates on MDN.

Comment 1

[Eric Shepherd [:sheppy]]

A little added detail:

The MDN team uses the keyword "dev-doc-needed" on Bugzilla to indicate that a bug is likely to mean that documentation needs updating.

IDL changes (including new files, deletions, and non-whitespace-only edits) almost always mean developer docs need to be updated or written.

When IDL changes, additions, or deletions occur, this hook would:

1. At least add the "dev-doc-needed" keyword if not present.

2. Whether or not the keyword was added, ideally this would also add a comment to the bug listing the affected files (and their respective interfaces, methods, properties, and so forth) were affected, as well as mentions of changes to global comments since those may be documentation details.

Bonus points for URLs to the files on dxr as well as to the diff of each file.

Comment 2

[:glob ✱]

updating bugzilla from a mercurial hook is undesirable as it can be an expensive operation.
reworking summary to state the goal rather than an implementation suggestion.

a better way to achieve this would be to write a service that listens to pulse for hg's change notification events[1], inspects the files touched by the commit, and updates bugzilla accordingly.

[1] http://mozilla-version-control-tools.readthedocs.io/en/latest/hgmo/notifications.html#pulse-notifications

Comment 3

[Gregory Szorc [:gps]]

What glob said.

Also, Phabricator can be used to perform actions when certain files change.

This bug is not actionable from my perspective.