PR#11203: Reword the FTI reminder Bugzilla comment - releng

releng

#11203 Reword the FTI reminder Bugzilla comment

Merged a year ago by churchyard. Opened a year ago by churchyard.

churchyard/releng fti-text into main

Reword the FTI reminder Bugzilla comment

Miro Hrončok • a year ago

d6684d1

Template the FTI reminder Bugzilla comment

Miro Hrončok • a year ago

be02bd7

scripts/ftbfs-fti/follow-policy.py

file modified

+5 -13

		`@@ -40,7 +40,7 @@`
		`)`


		`- def handle_orphaning(bug, tracker, comment_header):`
		`+ def handle_orphaning(bug, tracker, reminder_template):`
		`bz = bug.bugzilla`

		`history = bug.get_history_raw()["bugs"][0]["history"]`
		`@@ -76,11 +76,7 @@`
		`if not needinfos:`
		`print("Asking for the first needinfo")`
		`bzupdate = bz.build_update(`
		`- comment=comment_header+"""`
		`-`
		`- This is the first reminder (step 3 from https://docs.fedoraproject.org/en-US/fesco/Fails_to_build_from_source_Fails_to_install/#_package_removal_for_long_standing_ftbfs_and_fti_bugs).`
		`-`
		`- If you know about this problem and are planning on fixing it, please acknowledge so by setting the bug status to ASSIGNED. If you don't have time to maintain this package, consider orphaning it, so maintainers of dependent packages realize the problem.""",`
		`+ comment=reminder_template.render(nth="first", step=3, orphan_weeks=7),`
		`flags=[flag],`
		`)`
		`else:`
		`@@ -114,11 +110,7 @@`
		`if NOW - needinfo_after_week >= datetime.timedelta(weeks=3):`
		`print("Asking for another needinfo")`
		`bzupdate = bz.build_update(`
		`- comment=comment_header+"""`
		`-`
		`- This is the second reminder (step 4 from https://docs.fedoraproject.org/en-US/fesco/Fails_to_build_from_source_Fails_to_install/#_package_removal_for_long_standing_ftbfs_and_fti_bugs).`
		`-`
		`- If you know about this problem and are planning on fixing it, please acknowledge so by setting the bug status to ASSIGNED. If you don't have time to maintain this package, consider orphaning it, so maintainers of dependent packages realize the problem.""",`
		`+ comment=reminder_template.render(nth="second", step=4, orphan_weeks=4),`
		`flags=[flag],`
		`)`
		`else:`
		`@@ -433,10 +425,10 @@`
		`for src, b in current_ftis.items()`
		`if b.status == "NEW" and src not in orphaned`
		`}`
		`- comment_header = env.get_template("header.j2").render()`
		`+ reminder_template = env.get_template("reminder-fti.j2")`
		`for src, b in current_ftis.items():`
		`print(f"Checking {b.id} ({src})…")`
		`- handle_orphaning(b, ftibug, comment_header)`
		`+ handle_orphaning(b, ftibug, reminder_template)`


		`if __name__ == "__main__":`

scripts/ftbfs-fti/reminder-fti.j2

file added

+22

		`@@ -0,0 +1,22 @@`
		`+ {% include "header.j2" %}`
		`+`
		`+ This package fails to install and maintainers are advised to take one of the following actions:`
		`+`
		`+ - Fix this bug and close this bugzilla once the update makes it to the repository.`
		`+ (The same script that posted this comment will eventually close this bugzilla`
		`+ when the fixed package reaches the repository, so you don't have to worry about it.)`
		`+`
		`+ or`
		`+`
		`+ - Move this bug to ASSIGNED if you plan on fixing this, but simply haven't done so yet.`
		`+`
		`+ or`
		`+`
		`+ - Orphan the package if you no longer plan to maintain it.`
		`+`
		`+`
		`+ If you do not take one of these actions, the process at https://docs.fedoraproject.org/en-US/fesco/Fails_to_build_from_source_Fails_to_install/#_package_removal_for_long_standing_ftbfs_and_fti_bugs will continue.`
		`+ This package may be orphaned in {{ orphan_weeks }}+ weeks.`
		`+ This is the {{ nth }} reminder (step {{ step }}) from the policy.`
		`+`
		`+ Don't hesitate to ask for help on devel@lists.fedoraproject.org if you are unsure how to fix this bug.`

churchyard commented a year ago

Fixes https://pagure.io/releng/issue/11168

churchyard commented a year ago

See the two commits separately t better understand the change.

I took the comment by @kevin https://pagure.io/releng/issue/11168#comment-830893 and I changed "If you do not take one of these actions" to "If you do not take one of the first two actions" which is a bit harder to understand but factually more correct.

I've added the information about the remaining weeks and preserved the current information from the reminder (nth reminder and no. of the policy step).

churchyard commented a year ago

Should we also mention "fix this" as one of the things to do?