Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 709854 - Please improve the wording of CI bug reports to make urgency clear
Summary: Please improve the wording of CI bug reports to make urgency clear
Status: CONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Quality Assurance Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-02-16 21:44 UTC by Francisco Blas Izquierdo Riera (RETIRED)
Modified: 2020-02-16 21:44 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Francisco Blas Izquierdo Riera (RETIRED) gentoo-dev 2020-02-16 21:44:08 UTC
The current wording is particularly harsh and infers a sense of urgency that may not be appropriate:
"
Our automated repository checks [1] have detected that the 'klondike'
repository contains ebuilds that trigger fatal errors during the cache
regeneration. This usually means that the ebuilds call 'die' in global
scope indicating serious issues or have other serious QA violations.

Global-scope failures prevent the ebuild not only from being installed
but also from being properly processed by the Package Manager. Since
metadata can not be obtained for those ebuilds, no cache entries are
created for them and the Package Manager needs to retry running them
every time it stumbles upon them. This involves both a serious slowdown
and repeating error output while performing dependency resolution.

The most common cause of global-scope failures is use of removed or
banned APIs in old ebuilds. In particular, this includes eclasses being
removed or removing support for old EAPIs. Nonetheless there are also
other issues such as performing illegal operations in global scope
(external program calls), malformed bash in ebuilds or malformed
metadata.xml.

The error log for the repository can be found at:

  https://qa-reports.gentoo.org/output/repos/klondike.html

In particular, please look for highlighted error messages.

Please fix the issue ASAP, possibly via removing unmaintained, old
ebuilds. We reserve the right to remove the repository from our list if
we do not receive any reply within 4 weeks.

[1]:https://wiki.gentoo.org/wiki/Project:Repository_mirror_and_CI
"

Here is a differently proposed wording:
"
Our automated repository checks [1] have detected that the 'klondike'
repository contains ebuilds that trigger fatal errors during the cache
regeneration. This usually means that the ebuilds call 'die' in global
scope indicating serious issues or have other serious QA violations.

Global-scope failures prevent the ebuild not only from being installed
but also from being properly processed by the Package Manager. Since
metadata can not be obtained for those ebuilds, no cache entries are
created for them and the Package Manager needs to retry running them
every time it stumbles upon them. This involves both a serious slowdown
and repeating error output while performing dependency resolution.

The most common cause of global-scope failures is use of removed or
banned APIs in old ebuilds. In particular, this includes eclasses being
removed or removing support for old EAPIs. Nonetheless there are also
other issues such as performing illegal operations in global scope
(external program calls), malformed bash in ebuilds or malformed
metadata.xml.

The error log for the repository can be found at:

  https://qa-reports.gentoo.org/output/repos/klondike.html

In particular, please look for highlighted error messages.

Since this is likely to be causing slowdowns and other issues to all users of your overlay, you should address this issue as soon as you are able and no later than 4 weeks. This may be possibly done by removing unmaintained, old
ebuilds. We reserve the right to remove the repository from our list if
no action is taken within 4 weeks.

[1]:https://wiki.gentoo.org/wiki/Project:Repository_mirror_and_CI
"

That should make it clear that it is urgent but not "the ship is burning do something now" urgent.

Reproducible: Always

Steps to Reproduce:
1. Have a globally broken ebuild in your overlay
2. Get the bug report
Actual Results:  
See the prior wording

Expected Results:  
See the proposed wording

See #709120 for an example on how things may be missinterpreted.
Comment 1 Francisco Blas Izquierdo Riera (RETIRED) gentoo-dev 2020-02-16 21:44:45 UTC
Assigning to QA as propossed.