Highlight modifications more in change notifier emails



Release Engineering
Applications: Balrog (backend)
2 years ago
10 months ago


(Reporter: nthomas, Unassigned)


Firefox Tracking Flags

(Not tracked)


(Whiteboard: [lang=python][ready])


(1 attachment)



2 years ago
For rule changes, we're sending text/plain emails with content like this:

Changed by: ffxbld
Row(s) to be updated as follows:
{'alias': 'firefox-release' (unchanged),
 'backgroundRate': 100L (unchanged),
 'buildID': None (unchanged),
 'buildTarget': None (unchanged),
 'channel': 'release' (unchanged),
 'comment': 'default release rule updated by buildbot, DO NOT DELETE' (unchanged),
 'data_version': 96L ---> 97L,
 'distVersion': None (unchanged),
 'distribution': None (unchanged),
 'headerArchitecture': None (unchanged),
 'locale': None (unchanged),
 'mapping': 'Firefox-49.0.1-build3' ---> u'Firefox-49.0.2-build2',
 'osVersion': None (unchanged),
 'priority': 90L (unchanged),
 'product': 'Firefox' (unchanged),
 'rule_id': 145L (unchanged),
 'systemCapabilities': None (unchanged),
 'update_type': 'minor' (unchanged),
 'version': None (unchanged),
 'whitelist': None (unchanged)}

Everything is there, but you have to know to look for the lines with '--->' to get the gist of it. If we added an text/html part to the email, we could draw attention to changes using text in bold or a different colour.
In the text/plain part, could we start the email with a diff, so that the changes are up-front? Or even just the current text `|grep -v unchanged`

How about counting the number of changes in the subject line, for example: "UPDATE to rules: 3 changes"
is data version important to highlight?

Comment 3

2 years ago
Created attachment 8808538 [details] [review]
Separate out the changing values and show them first

Just enough to scratch the itch.
Attachment #8808538 - Flags: review?(bhearsum)
Attachment #8808538 - Flags: review?(bhearsum) → review+

Comment 4

2 years ago
Commit pushed to master at https://github.com/mozilla/balrog

bug 1311827: Highlight modifications more in change notifier emails (#172). r=bhearsum
Looks like this is working well in stage:
Changed by: bhearsum@mozilla.com
Row(s) to be updated as follows:
Changed values:
{'data_version': 165L ---> 166L,
 'mapping': 'Firefox-44.0b2-build1' ---> u'Firefox-49.0.1-build3'}

{'alias': None,
 'backgroundRate': 100L,
 'buildID': None,
 'buildTarget': None,
 'channel': 'beta',
 'comment': None,
 'distVersion': None,
 'distribution': None,
 'fallbackMapping': None,
 'headerArchitecture': None,
 'locale': None,
 'osVersion': None,
 'priority': 90L,
 'product': 'Firefox',
 'rule_id': 32L,
 'systemCapabilities': None,
 'update_type': 'minor',
 'version': None,
 'whitelist': None}
Depends on: 1316112
In production. Were you planning to leave this open for other improvements, Nick?
Flags: needinfo?(nthomas)

Comment 7

2 years ago
The text changes are enough for me so FIXED would be OK. If you would like to keep it open for contributors to work on that's fine too.
Flags: needinfo?(nthomas)
Priority: -- → P3
Whiteboard: [lang=python][ready]

Comment 8

10 months ago
I'm going to close this as fixed, we can file bugs for specific follow-ups.
Last Resolved: 10 months ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.