(create blocker bug process SOP draft)
m (make keywords better readable)
|(33 intermediate revisions by 4 users not shown)|
|Line 1:||Line 1:|
== Background ==
== Background ==
Fedora uses a system of ''tracker bugs'' to keep track of ''release blocker bugs'' - bugs that are blocking
Fedora uses a system of ''tracker bugs'' to keep track of ''release blocker bugs'' - bugs that are blocking its releases and which must be fixed before these releases can proceed. The [[Fedora_Release_Criteria]] should be used to determine whether a bug is a blocker for a given release. This page defines the process by which bugs are proposed, reviewed and accepted as blocker bugs, and how blocker bugs are then tracked.
See also the [[QA:
See also the [[QA:|bug process]], which defines the similar process for bugs - those which do not block the release, but which are considered high priority for tracking and fixing .
//. . be a release the bug wish to is , the bug blocker.
blockers or the [] for release can be , as which is to a be as a . In these , the be as a blocker .
which be for the to .
that the release and so as a bug the .
to fix bug, , the in to
[[|]], to to '' ''
'' '''''' ,
to . should '''''' until to repositorythe build, to the , bug '''CLOSED ERRATA'''
the pushed to
the and the the to
the bug .
Latest revision as of 10:08, 21 September 2020
Fedora uses a system of tracker bugs to keep track of release blocker bugs - bugs that are blocking its milestone releases (Beta, Final) and which must be fixed before these releases can proceed. The Fedora_Release_Criteria should be used to determine whether a bug is a blocker for a given release. This page defines the process by which bugs are proposed, reviewed and accepted as blocker bugs, and how blocker bugs are then tracked.
See also the freeze exception bug process, which defines the similar process for freeze exception bugs - those which do not block the release, but which are considered high priority for tracking and fixing and for which fixes will be accepted even during release freezes.
Or, when does this process affect me?
The process of nominating and reviewing blocker bugs is active to some degree at all times. It is particularly visible, however, after the Milestone freezes for each milestone of a release (Beta and Final). At the Milestone freeze (Beta freeze or Final freeze), the stable fedora package repository is frozen, meaning packages can no longer move from the updates-testing repository to the stable repository from which the 'candidate' composes are created.
If a Fedora milestone release is currently in a milestone freeze (you can check the schedule for the next release here) and you are a packager or tester and you believe a build of your package or a package you are testing should be in the milestone release, this process concerns you. After the milestone freeze, the build can only be promoted to 'stable' and included in the release if it fixes a bug that is granted blocker or freeze exception status.
After the milestone release is finished, the milestone freeze is lifted and builds can be marked as stable again without following this process, so if the build can wait until after the milestone release, you do not need to follow this process.
Proposing blocker bugs
You can use the Blocker Bugs web application to propose a bug as a blocker. It will guide you through the process.
If you have an issue with the guided process or want to propose a blocker directly from Bugzilla for efficiency, you can use the manual process.
To propose a bug as a blocker for a release, mark it as blocking the tracker bug for blocker bugs in that release. To do this, enter the alias or bug ID of the tracker bug into the Blocks: field in Bugzilla. The aliases for the blocker tracker bugs follow a consistent naming scheme. For the next release, the Beta tracker will always be called BetaBlocker, and the final release tracker will always be called FinalBlocker. Rarely, you may need to propose a bug as a blocker for the next release but one - in this case, prepend FXX (where XX is the release number) to the name of the alias, e.g. F39BetaBlocker. So, to mark a bug as a blocker for the release of Fedora 38 Beta, you would set it to block the bug BetaBlocker. You can find a full list of tracker bugs at BugZappers/HouseKeeping/Trackers.
Reviewing blocker bugs
Proposed blockers are reviewed and either accepted or rejected as blockers in collaboration between three stakeholder groups: QA, Development and ReleaseEngineering. This is mostly done during weekly meetings for the express purpose of reviewing blocker and freeze exception bugs: the procedure followed during these meetings is documented here. Blocker review meetings usually occur every Monday - immediately after the QA meeting - so long as there is at least one proposed blocker, but special review meetings can be scheduled at other times when necessary. They are always announced to the test-announce mailing list, which is CC'ed to devel. The blocker review meetings are public, and reporters who propose a bug as a blocker are allowed and indeed encouraged to attend the meeting where it is reviewed.
When appropriate, proposed blockers may also be reviewed between meetings by Bugzilla comment discussion, or during the engineering readiness meeting (also known as a go/no-go meeting) which is convened to decide whether a release candidate should be approved as a final release. In these cases, consensus between the three stakeholder groups should still be reached in order to accept or reject a bug as a blocker. However, review should not be done as part of QA meetings. If blocker review is required or desirable at the time of a QA meeting, a proper blocker bug review meeting should be convened immediately following the QA meeting. Bugs which are rejected as blockers can be considered for the freeze exception bug process.
Bugs that are accepted as blockers for the relevant release will be marked with the Whiteboard field
AcceptedPreviousRelease (see below for details on these). Bugs which are rejected as blockers will be updated to no longer block the relevant tracker bug, and have the
RejectedBlocker Whiteboard field added so that if they are proposed as blockers again, it is clear they have already been considered and rejected. Therefore, a bug which has been proposed but not accepted or rejected can be identified by the lack of a relevant Whiteboard field. All changes to blocker status should also be documented with a comment. The comment should explain the rationale behind the decision and should link to the summary or logs of the meeting at which the decision was made.
Normal, 0-Day and Previous Release blockers
The whiteboard fields
AcceptedPreviousRelease are used to distinguish between three categories of blocker bug.
AcceptedBlocker is the most common case. This is used for bugs where the fix must appear as part of the final frozen release itself (usually, on one of the media).
Accepted0Day is used for cases where the fix does not need to appear in the final frozen release, but must be available as an update on release day.
AcceptedPreviousRelease is used for cases where the fix must appear as an update for one or more stable releases.
The most common case for both
AcceptedPreviousRelease is upgrade-related problems. For instance, there may be a bug in the upgrade mechanism itself; this will usually need to be fixed in the existing stable releases, not the new release. There may be a bug in a package in the new release which prevents systems with that package installed upgrading correctly; the fix for such a bug does not need to be part of the frozen final release, as upgrades typically use the online package repositories, but if the affected package is very commonly installed, we may decide that we wish to ensure the fixed package is available from the updates repository on release day, and make the bug an accepted 0-Day blocker.
Generally speaking, any bug that is agreed to be a violation of the release criteria should be accepted as a blocker bug for the next relevant milestone release. However, bearing in mind the Fedora life cycle's emphasis on both time and quality, in some cases we may make an exception. There are two main categories of bug that may be 'exceptional':
- Last minute blocker bugs - bugs proposed as blockers 5 days or fewer before the scheduled Go_No_Go_Meeting for a milestone release (Beta or Final) can be considered under this policy, as there are some circumstances in which we believe it is not sensible to delay an otherwise-impending release to fix a bug which would usually be accepted as a blocker if discovered earlier. In these circumstances, the bug can instead be accepted as a blocker for the next milestone release.
- Difficult to fix blocker bugs - bugs which it may not be practical to fix within a reasonable time frame for the release to be made (due to e.g. complexity or resource constraints)
The stakeholder groups must first agree, following the procedures described above, that the bug violates the release criteria and so would otherwise be accepted as a blocker bug for the imminent release.
After that, the stakeholder groups may separately make a decision as to whether to invoke this policy and consider delaying the blocker status to a future milestone release. Anyone attending the meeting (or otherwise taking part in the discussion, if it is being done outside of a meeting) can suggest that this evaluation be done. In making the decision, the following factors can be considered:
- How prominently visible the bug will be
- How severe the consequences of the bug are
- How many users are likely to encounter the bug
- Whether the bug could or should have been proposed earlier in the cycle
- Whether the current stable release is affected by the bug
- Whether delaying the release may give us an opportunity to carry out other desirable work
- Possible effects of the expected delay on Fedora itself and also to downstream projects
- Whether an additional delay to fix the bug, combined with any prior delays in the cycle, results in the total delay becoming unacceptable in regard to the Fedora_Release_Life_Cycle
In almost all 'exceptional' cases, the bug should be accepted as a blocker either for the very next milestone release, or for the equivalent milestone for the next release (if it would not violate the criteria for the very next milestone). For very complex difficult to fix cases, a longer extension may be needed.
Certain types of bugs are considered automatic blockers. These bugs can be marked as accepted by any member of one of the stakeholder groups without formal review. A comment should accompany this change, explaining that it has been made under the automatic blocker policy and linking to this section of this page. If anyone believes that a bug has been incorrectly marked as AcceptedBlocker in this way, they may propose that it be formally reviewed by appending a comment to the bug or by raising it during a blocker review meeting. Only the following types of bug are considered automatic blockers. Note that where an item on this list applies to release-blocking images, a corresponding issue in a non-release-blocking image would likely be an automatic freeze exception, under the corresponding policy.
- Bugs which entirely prevent the composition of one or more of the release-blocking images required to be built for a currently-pending (pre-)release
- Incorrect checksums present on any of the release-blocking images (failures of QA:Testcase_Mediakit_ISO_Checksums)
- Unresolved dependencies on a release-blocking DVD-style (offline installer) image (failures of QA:Testcase_Mediakit_Repoclosure)
- File conflicts between two packages on a release-blocking DVD-style (offline installer) image without an explicit Conflicts: tag (failures of QA:Testcase_Mediakit_FileConflicts)
- Complete failure of any release-blocking image to boot at all under any circumstance - "DOA" image (conditional failure is not an automatic blocker)
- Any release-blocking Beta or Final image exceeding its maximum size (failures of QA:Testcase_Mediakit_ISO_Size)
- The default desktop background in a release-blocking desktop being the same as one of the last two stable releases
- Bugs designated as blockers by FESCo (see Fedora 38_Beta_Release_Criteria#FESCo_blocker_bugs)
No other type of bug can be considered an automatic blocker under any circumstance. In particular, "I think it is obviously a blocker" is not a valid reason to use this procedure. If you believe another type of bug should be added to the list, please propose the change on the test@ mailing list.
Tracking blocker bugs
Again, tracking blocker bugs and ensuring that they are fixed is a collaborative effort between the QA, Development and Release Engineering groups. The QA:SOP_Blocker_Bug_Meeting process includes reviewing the status of existing blockers and ensuring that the appropriate resources to fix them are in place, as well as evaluating proposed blockers. QA group members are encouraged to prioritize testing of blocker bug fixes, development group members are encouraged to prioritize developing fixes for blocker bugs, and release engineering group members are encouraged to prioritize the release of fixes for blocker bugs (after appropriate testing). Each group should have its own processes for ensuring its responsibilities in relation to blocker bugs are met.
In Bugzilla, blocker bugs should follow the normal workflow, with special attention paid by the development group to submitting proposed fixes to the updates-testing repository so they reach MODIFIED and ON_QA status, and special attention paid by the QA group to testing proposed fixes and setting ones that are tested successfully to the VERIFIED status. No blocker bug should be set to CLOSED ERRATA until a fix is actually released to the stable repository for the release in question and also included in an RC compose (if it is related to a package from such a package set). If a working fix is added to a TC or RC build, but not yet pushed to the stable repository, the bug should not be marked CLOSED ERRATA, as this may result in the fix not being pushed to the stable repository and the fix accidentally omitted from the next candidate build as it is no longer possible to track the bug.
Tracking AcceptedPreviousRelease blocker bugs
We need to take even greater care when closing
AcceptedPreviousRelease blockers. They should stay in the VERIFIED state until the MirrorManager's metalink does not refer to any older metadata related to that repository. Otherwise some people could get served older metadata not containing the fixed build, which might have severe consequences especially for system upgrades. Only when it is guaranteed that MirrorManager refers only to the push containing the fixed package or newer pushes, we should mark this bug as CLOSED ERRATA.
The full process is this:
- Wait until Bodhi announces that the fixed build has been pushed to stable updates.
python track-previous-release-blocker.py BUILD_NVRcommand (retrieved from qa-misc git) to receive a PASSED/FAILED status whether this build is already available to all our users.
- It might take several days (several pushes to updates repo) before the script returns its approval. If you need to speed up the process (i.e. when being very close to Go No Go Meeting), use a compose request ticket and ask RelEng to run
mm2_emergency-expire-repotool on that particular repo. That will drop all alternate metadata from the metalink. Then run the script again to verify this.
- Once the script approves this, you can mark the bug as CLOSED ERRATA.