From 31f76c0625660c95c8520130d3563a62212457d9 Mon Sep 17 00:00:00 2001 From: FeRD (Frank Dana) Date: Aug 26 2020 05:05:06 +0000 Subject: [PATCH 1/5] Updates policy: Clean up asciidoc conversion Fix issues introduced by automated conversion to AsciiDoc, and update: - Example packages for various update types restored (with links) - Replace fedorahosted.org URLs and references to trac with Pagure links - Link to HyperKitty for "devel list" mentions - Some broken/lost wiki links restored - Replace '[multiblock footnote omitted]' insertions with additional references to labeled footnote - Bold all remaining "SHOULD" "MUST" etc. - Consistently capitalize "Bodhi" - Make spelling, grammar, punctuation fixes --- diff --git a/fesco/modules/ROOT/pages/Updates_Policy.adoc b/fesco/modules/ROOT/pages/Updates_Policy.adoc index dc8b5f7..1c290ab 100644 --- a/fesco/modules/ROOT/pages/Updates_Policy.adoc +++ b/fesco/modules/ROOT/pages/Updates_Policy.adoc @@ -3,7 +3,8 @@ Fedora has differing policies for each of its branches. This document describes for maintainers what sort of updates should be created in packages for each of the various branches of existing Fedora. In the event of questions or clarifications, please file a -link:https://fedorahosted.org/fesco/newticket[FESCo trac ticket] or discuss on the devel list. In +link:https://pagure.io/fesco/new_issue[FESCo ticket] or discuss on the +link:https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/[devel list]. In general, releases should go from less conservative (rawhide) to more so (the oldest supported stable release). This document attempts to describe when and what kinds of updates maintainers should push to Fedora users of its various branches. The @@ -11,8 +12,8 @@ link:https://fedoraproject.org/wiki/Stable_release_updates_vision[Stable release Fedora Board includes more high level discussion and philosophy, while this document is more a practical guide. Refer to link:https://fedoraproject.org/wiki/Package_update_HOWTO[Package update HOWTO] for the technical steps on -pushing the updates. The link:https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle[Fedora Release -Life Cycle] provides a more detailed overview of the development process. +pushing the updates. The link:https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle[Fedora Release Life Cycle] +provides a more detailed overview of the development process. == Rawhide / devel / master @@ -20,7 +21,7 @@ link:https://fedoraproject.org/wiki/Releases/Rawhide[Rawhide] is the always-roll updates built for rawhide are composed every day and pushed out to all rawhide consumers. New builds against this tree also are added to the build root (ie, other packages build from them). -repos available: link:https://fedoraproject.org/wiki/Repositories#rawhide[_rawhide_] +Repos available: link:https://fedoraproject.org/wiki/Repositories#rawhide[_rawhide_] Since link:https://fedoraproject.org/wiki/Changes/GatingRawhidePackages[Rawhide Gating change] was introduced, package updates in Fedora Rawhide need to pass verification before they land in the rawhide repositories. This @@ -35,20 +36,22 @@ see link:https://docs.fedoraproject.org/en-US/rawhide-gating/optin/[Rawhide Gati For updates to rawhide packages, Maintainers SHOULD: -* Try not to push a clearly broken build (breaks the default buildroot package set, etc) -* When a proposed update contains an ABI or API change: notify *a week in advance* both fedora-devel - and maintainers directly (using the` _packagename-owner@_` alias) whose packages depend on yours to - rebuild or offer to do these rebuilds for them. +* Try not to push a broken build (breaks the default buildroot package set, etc). +* When a proposed update contains an ABI or API change: notify *a week in advance* both the + link:https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/[devel list] + and maintainers directly (using the ``_packagename_-\owner@fedoraproject.org`` alias) + whose packages depend on yours to rebuild or offer to do these rebuilds for them. * Use a separate buildsystem tag when dealing with mass builds of many packages, so they can land at - the same time. File a ticket with link:https://fedorahosted.org/rel-eng/newticket[rel-eng] for this. + the same time. File a link:https://pagure.io/releng/new_issue[rel-eng ticket] for this. * Feel free to push out the newest version of packages as long as they do not cause breakage. Also keep in mind when the next Fedora release will be branched off, and be fairly confident that there will be a stable enough release in time for the next Fedora release. Otherwise you may have to back down to an older, stable version after the branching, which may involve epochs and other inconveniences. -* If approved by FESCo push pre-release versions of low level packages. Certain low-level packages - (approved by FESCo), including (but not limited to) glibc and gcc to provide pre-release versions - here. The benefits of the early real-world testing of and upstream collaboration on these key +* If approved by FESCo, push pre-release versions of low level packages. + FESCo approves certain packages, including (but not limited to) ``glibc`` and ``gcc``, + to provide pre-release versions here. + The benefits of the early real-world testing of and upstream collaboration on these key packages far exceeds the risks that they may introduce. == Branched release @@ -64,16 +67,16 @@ for the next release, so changes should be careful and considered and heading to === https://fedoraproject.org/wiki/Releases/Branched[Branched], pre-Bodhi enabling For a short time after link:https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle[the branch event -happens] but before the <> point, the Branched release works just like Rawhide: +happens] but before the <> point, the Branched release works exactly like Rawhide: builds submitted by packagers are considered link:https://fedoraproject.org/wiki/Repositories#stable[stable] immediately, and sent to the link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_ repository] directly in the next nightly -compose. There are no restrictions beyond those for Rawhide at this point, but maintainers SHOULD be +compose. There are no restrictions beyond those for Rawhide at this point, but maintainers *SHOULD* be thinking about stabilization from this point onwards, and making sure their packages will be in good condition well in advance of the stable release. Some packages will be signed at this point, but not all of them. You may have to use `--nogpgcheck` to install or update. -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] [[bodhi-enabling]] === Bodhi enabling @@ -87,7 +90,7 @@ point_ occurs on the day of the link:https://fedoraproject.org/wiki/Milestone_fr it is important to remember that they are distinct events: the Beta freeze lasts until Beta release, but Bodhi enabling is permanent. -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] At this point all packages will be signed and gpgcheck should be enabled for all installs/updates. @@ -95,25 +98,26 @@ At this point all packages will be signed and gpgcheck should be enabled for all [[pre-beta]] === Pre Beta -This is the time between the _Bodhi enabling point_ and the Beta release. During this time we are +This is the time between the <> point and the Beta release. During this time we are attempting to stabilize the major versions of software that will be shipped with the final release of the OS. Major updates can be tolerated, but breaking things for early testers should be avoided if possible. Additionally, as we get close to Alpha or Beta releases any change that breaks composes of Live media, install media or testing should be avoided. Packages for Changes should be landing and getting major testing. -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], +link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] -From this point onwards Maintainers **MUST**footnote:[_Must_ requirements are enforced by Bodhi.]: +From this point onwards Maintainers **MUST**footnote:enforced[_Must_ requirements are enforced by Bodhi.]: * Push all updates first to updates-testing. -* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates MUST either get - one +1 karma, OR spend at least 14 days in updates-testing and have no negative karma before being +* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates *MUST* either get + one +1 karma, *OR* spend at least 14 days in updates-testing and have no negative karma before being moved to stable. -* All non critical path updates MUST either reach the prescribed karma level for that update, OR +* All non critical path updates *MUST* either reach the prescribed karma level for that update, OR spend at least 3 days in updates-testing before being allowed to move to stable. -and Maintainers SHOULD (not enforced): +and Maintainers *SHOULD* (not enforced): * Avoid ABI/API changes where possible. If unavoidable, should coordinate a side-tag to rebuild packages in or a mass build/update, by filing a https://pagure.io/releng/new_issue[releng ticket]. @@ -121,15 +125,15 @@ and Maintainers SHOULD (not enforced): [[milestone-freezes]] ==== Milestone freezes -During this period there are two link:https://fedoraproject.org/wiki/Milestone_freezes[Milestone -freezes], _Alpha freeze_ and _Beta freeze_. Each is scheduled to run for the two weeks leading up to +During this period there are two link:https://fedoraproject.org/wiki/Milestone_freezes[Milestone freezes], +_Alpha freeze_ and _Beta freeze_. Each is scheduled to run for the two weeks leading up to the release date (and in fact lasts until the release is signed off, even if it is delayed). During these times, builds will not be marked _stable_ and moved from link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] to link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] (and hence included in the milestone -release composes) except for those approved under the -link:https://fedoraproject.org/wiki/QA:SOP_blocker_bug_process[QA SOP blocker bug process] or -link:https://fedoraproject.org/wiki/QA:SOP_freeze_exception_bug_process[QA SOP freeze exception bug process]. +release composes) except for those approved under the Fedora QA team +link:https://fedoraproject.org/wiki/QA:SOP_blocker_bug_process[blocker bug process] or +link:https://fedoraproject.org/wiki/QA:SOP_freeze_exception_bug_process[freeze exception bug process]. Once the milestone release is made, these freezes are lifted. These freezes are technically not a part of the Updates Policy, but are briefly mentioned here for clarity. The link:https://fedoraproject.org/wiki/Milestone_freezes[Milestone freezes] page provides more @@ -145,34 +149,40 @@ mind that in most cases, the state your package has reached in the stable link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] repository at the time of the Final freeze is the state it will be in for the final release. -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], +link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] -From this point onwards maintainers **MUST**[multiblock footnote omitted]: +From this point onwards maintainers **MUST**footnote:enforced[]: * Avoid Major version updates, ABI breakage or API changes if at all possible. * Push updates first to updates-testing. -* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates MUST either have - a sum of +2 karma, OR spend at least 14 days in updates-testing and have no negative karma. -* All non critical path updates MUST either reach the prescribed karma level for that update, OR - spend at least 7 days in updates-testing before being allowed to go to stable. +* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] + updates *MUST* either have a sum of +2 karma, + *OR* spend at least 14 days in updates-testing and have no negative karma. +* All non critical path updates *MUST* either reach the prescribed karma level for that update, + *OR* spend at least 7 days in updates-testing before being allowed to go to stable. [[pre-release]] === Pre release This is the time after the link:https://fedoraproject.org/wiki/Milestone_freezes[Final freeze]. During this time the release is being composed and only packages granted exceptions through the -QA:SOP_blocker_bug_process or QA:SOP_freeze_exception_bug_process are marked as _stable_ and moved -to the link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_ repository]. The -link:https://fedoraproject.org/wiki/Repositories#updates[_updates_] repository is enabled at some point -during this time, and packages other than freeze exception / blocker fixes are queued for so called -"zero day" updates, meaning they will be available in the _updates_ repository at the time of the -release (day zero). - -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates[_updates_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] +link:https://fedoraproject.org/wiki/QA:SOP_blocker_bug_process[blocker bug process] or +link:https://fedoraproject.org/wiki/QA:SOP_freeze_exception_bug_process[freeze exception bug process] +are marked as _stable_ and moved to the +link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_ repository]. +The link:https://fedoraproject.org/wiki/Repositories#updates[_updates_] +repository is enabled at some point during this time, +and packages other than freeze exception / blocker fixes are queued for so called "zero day" updates, +meaning they will be available in the _updates_ repository at the time of the release (day zero). + +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], +link:https://fedoraproject.org/wiki/Repositories#updates[_updates_], +link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] During this period: -* All updates pulled into the release **MUST**[multiblock footnote omitted] fix an accepted blocker +* All updates pulled into the release **MUST**footnote:enforced[] fix an accepted blocker or freeze exception bug. * All update pushes will go to updates-testing. * All link:https://fedoraproject.org/wiki/Critical_path_package[ critical path] updates *MUST* either @@ -204,20 +214,22 @@ Rebases should be carefully considered with respect to their dependencies. A reb (or provided) a new Python ABI, for example, would almost certainly not be allowed. ABI changes in general are very strongly discouraged, they force larger update sets on users and they make life difficult for third-party packagers. Additionally, updates that convert resources or configuration -one way (ie, from older->newer) should be approached with extreme caution as there would be much +one way (i.e., from older->newer) should be approached with extreme caution as there would be much less chance of backing out an update that did these things. Whenever possible packagers should work with upstream to come up with stable branch releases or common patches for older releases, particularly when rebasing would require large dependency chain updates. -repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], https://fedoraproject.org/wiki/Repositories#updates[_updates_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] +Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], +https://fedoraproject.org/wiki/Repositories#updates[_updates_], +link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] [[updates-to-critical-path-packages]] === Updates to 'critical path' packages Updates that constitute a part of the 'critical path' package set (defined -below) *including security updates* MUST follow the rules as defined for +below) *including security updates* *MUST* follow the rules as defined for link:https://fedoraproject.org/wiki/Critical_path_package[critical path packages] for pending releases, meaning: @@ -228,10 +240,18 @@ pending releases, meaning: For the purposes of this policy, the 'critical path' package set is defined as the following: -* The current link:https://fedoraproject.org/wiki/Critical_Path_Packages[critical path package set] +* The current + link:https://fedoraproject.org/wiki/Critical_Path_Packages[critical path package set] * All major desktop environments' core functionality (GNOME, KDE, Xfce, LXDE) -* Package updating frameworks (, ) -* Major desktop productivity apps. An initial list would be , (konqueror), , , (kmail). +* Package updating frameworks + (link:https://apps.fedoraproject.org/packages/gnome-packagekit[``gnome-packagekit``], + link:https://apps.fedoraproject.org/packages/apper[``apper``]) +* Major desktop productivity apps. An initial list would be + link:https://apps.fedoraproject.org/packages/firefox[``firefox``], + link:https://apps.fedoraproject.org/packages/kde-baseapps[``kde-baseapps``](konqueror), + link:https://apps.fedoraproject.org/packages/thunderbird[``thunderbird``], + link:https://apps.fedoraproject.org/packages/evolution[``evolution``], + link:https://apps.fedoraproject.org/packages/kdepim[``kdepim``](kmail). Changes to this definition may only be made by xref:index.adoc[FESCo] or their delegate. @@ -243,7 +263,7 @@ All other updates *MUST* either: * reach the criteria laid out in the previous section *OR* * reach the positive Bodhi karma threshold specified by the updates submitter *OR* * spend some minimum amount of time in - link:https://fedoraproject.org/wiki/QA:Updates_Testing[updates-testing], currently one week + link:https://fedoraproject.org/wiki/QA:Updates_Testing[_updates-testing_], currently one week Package maintainers *MUST*: @@ -265,7 +285,7 @@ exception class to FESCo and/or request an exception for your specific update ca Note that you should open this dialog *BEFORE* you build or push updates. In the event that an issue is raised in the middle of an update already in progress, make sure you turn off autokarma pushes — -this can be done while the update is pending in bodhi. +this can be done while the update is pending in Bodhi. The following things would be considered in a exception request. @@ -284,7 +304,7 @@ Things that would make it less likely to grant a request: * The update causes behavior changes (something that was denied is allowed, etc) * The update changes the UI the end user sees (moves menus or buttons around, changes option names on command line) -* The update fixes bugs that no fedora user has reported nor would affect many fedora users (ie, +* The update fixes bugs that no fedora user has reported nor would affect many fedora users (i.e., fixes for other platforms or configurations). [[exceptions-list]] @@ -295,8 +315,8 @@ The following packages have been granted exceptions for the following reasons: [[kernel-package]] ===== kernel package -* Manpower of kernel maintainers prevents us from easily backporting all the bug fixes, security - fixes and new hardware enablement we would need to maintain older, no longer supported kernels. +* Time and resource constraints prevent the kernel maintainers from backporting all the bug fixes, + security fixes and new hardware enablement we would need to maintain older, no longer supported kernels. * Additionally, multiple kernels can be installed/booted, allowing users to boot older kernels in the event newer ones fail to work, and allowing time for kernel maintainers to fix any critical @@ -312,16 +332,16 @@ details ===== girara and zathura These packages are allowed to update in stable releases together. -See https://fedorahosted.org/fesco/ticket/1255 +See link:https://pagure.io/fesco/issue/1255[this FESCo ticket]. [[security-fixes]] ==== Security fixes If upstream does not provide security fixes for a particular release, and if backporting the fix -would be impractical, then the package maintainer(s) MUST open a FESCo ticket for approval to rebase +would be impractical, then the package maintainer(s) *MUST* open a FESCo ticket for approval to rebase the package to a version that upstream supports. -Package maintainers MUST: +Package maintainers *MUST*: * Avoid Major version updates, AI breakage, or API changes if at all possible * Avoid changing the user or developer experience if at all possible @@ -355,7 +375,11 @@ changes, then a package may be rebased if necessary. This includes network games hardware music players, cell phones, etc. These packages may also be updated to add support for new devices or formats in compatible ways. -Examples of this type of package: , , , +Examples of this type of package: +link:https://apps.fedoraproject.org/packages/libopenraw[``libopenraw``], +link:https://apps.fedoraproject.org/packages/libimobiledevice[``libimobiledevice``], +link:https://apps.fedoraproject.org/packages/calibre[``calibre``], +link:https://apps.fedoraproject.org/packages/pilot-link[``pilot-link``] [[database-packages]] ==== Database packages @@ -366,7 +390,9 @@ mechanisms), but the rules engine is usually fairly static. However, if the main changes to require a new version of the rules engine, then the package may be a candidate for rebasing. -Examples of this type of package: , +Examples of this type of package: +link:https://apps.fedoraproject.org/packages/spamassassin[``spamassassin``], +link:https://apps.fedoraproject.org/packages/clamav[``clamav``] [[examples]] ==== Examples @@ -388,17 +414,17 @@ Examples of this type of package: , major user experience change, and would not be allowed. * WebKit requires an update to solve a security problem. This requires updating Midori to a version - with some minor menu layout changes. This would be a judgement call based on how intrusive the + with some minor menu layout changes. This would be a judgment call based on how intrusive the changes are (removing the File menu would be rude, but moving the plugin configuration menu item would be acceptable). * Firefox releases an update that only contains changes for other platforms. This update could be - pushed to rawhide (just to keep up with the latest version), but should not be pushed to stable + pushed to rawhide (to keep up with the latest version), but should not be pushed to stable releases, as it does no good to our users and wastes resources to build, update, mirror and download to our users. * Terminal fails to build from source when tested in a mass rebuild. An updated package should be - pushed to rawhide. Fixes for stable releases should be tested and even commited, but unless there + pushed to rawhide. Fixes for stable releases should be tested and even committed, but unless there is a problem with the previous existing build in the stable release, no update should be issued. This update would not change any user facing functions of the package. @@ -406,7 +432,7 @@ Examples of this type of package: , that is in Fedora N and Fedora N-1. This release includes a large number of bugfixes, mixed with enhancements and security fixes. An exception for this type of update would need to consider: ability to backport major fixes/security issues, type and amount of bugs fixed, ability to not - update other parts of fedora for this update (ie, avoid qt or other base library ABI changes), + update other parts of fedora for this update (i.e., avoid Qt or other base library ABI changes), amount of testing and end user visible changes. An exception like this would be on a case by case bases based on all the above. @@ -414,7 +440,7 @@ Examples of this type of package: , == Problems or issues with Updates In an effort to learn from any mistakes made, in the event of a update causing a widespread or -serious problem for Fedora users, please file a FESCo trac ticket. FESCo will discuss and try and +serious problem for Fedora users, please file a link:https://pagure.io/fesco/new_issue[FESCo ticket]. FESCo will discuss and try and work to prevent the issue from happening again. A past record of such issues can be found at link:https://fedoraproject.org/wiki/Updates_Lessons[Updates Lessons]. @@ -430,8 +456,7 @@ single update containing the updated versions of all three packages. It is a bad three separate updates, because if the update for package A is pushed stable before the updates for packages B and C, it will cause dependency problems. There is information on how to submit multi-package updates in the -link:https://fedoraproject.org/wiki/Package_update_HOWTO#Updating_inter-dependent_packages[package update -HOWTO]. +link:https://fedoraproject.org/wiki/Package_update_HOWTO#Updating_inter-dependent_packages[package update HOWTO]. [[taskotron]] == Taskotron @@ -441,17 +466,18 @@ dependency check (to ensure all dependencies of the package(s) can be fulfilled repositories) and an upgrade path check (to ensure the update does not break the upgrade path from release to release, i.e. that the update does not contain a package versioned higher than the newest version of the same package available in a later Fedora release). Taskotron adds comments to Bodhi -with the results of these test runs. A failure of either test will cause Bodhi#Karma_Automatism for -the update to be disabled (if it was enabled). If you submit an update that fails one of these -tests, please check the result and fix the problem. If you are sure the failure is an error in the +with the results of these test runs. Failing either test will disable +link:https://fedoraproject.org/wiki/Bodhi#Karma_Automatism[Bodhi karma automatism] for +the update (if it was enabled). If you submit an update that fails one of these +tests, please check the result and fix the problem. If you are sure there is an error in the test rather than an error in your package, you may still manually push the update or re-enable karma automatism. Previously, the old AutoQA system ran similar checks to Taskotron. The scope of these automated checks is expected to expand in future. The -link:https://fedoraproject.org/wiki/QA:Package_Update_Acceptance_Test_Plan[Package Update Acceptance Test Plan] was written as the original -plan for AutoQA update validation, and may still be seen as a framework for future work on -Taskotron. +link:https://fedoraproject.org/wiki/QA:Package_Update_Acceptance_Test_Plan[Package Update Acceptance Test Plan] +was written as the original +plan for AutoQA update validation, and may still be seen as a framework for future work on Taskotron. [[bodhi-use]] == Bodhi Use @@ -459,7 +485,7 @@ Taskotron. Bodhi is meant as the method for getting updates into an existing release or pre-release. It does provide a testing mechanism to make sure that nothing unforeseen will arise, but the expectation is that packages submitted are likely ready to ship as an update. As such, any packages submitted to -bodhi must be done with the intent that the package submitted is ready for general consumption. The +Bodhi must be done with the intent that the package submitted is ready for general consumption. The users kind enough to test these packages have come to expect this, and doing anything else moves against their good will, and is likely to drive testers away. Bodhi and updates-testing are not a place for experimentation or advanced notification of potentially disruptive updates. These should From 688fa27a6b81afce3750df51173b04c5ca20fbbf Mon Sep 17 00:00:00 2001 From: FeRD (Frank Dana) Date: Aug 26 2020 05:07:51 +0000 Subject: [PATCH 2/5] Update package links, apps URLs => src URLs --- diff --git a/fesco/modules/ROOT/pages/Updates_Policy.adoc b/fesco/modules/ROOT/pages/Updates_Policy.adoc index 1c290ab..287058d 100644 --- a/fesco/modules/ROOT/pages/Updates_Policy.adoc +++ b/fesco/modules/ROOT/pages/Updates_Policy.adoc @@ -244,14 +244,15 @@ For the purposes of this policy, the 'critical path' package set is defined as t link:https://fedoraproject.org/wiki/Critical_Path_Packages[critical path package set] * All major desktop environments' core functionality (GNOME, KDE, Xfce, LXDE) * Package updating frameworks - (link:https://apps.fedoraproject.org/packages/gnome-packagekit[``gnome-packagekit``], - link:https://apps.fedoraproject.org/packages/apper[``apper``]) -* Major desktop productivity apps. An initial list would be - link:https://apps.fedoraproject.org/packages/firefox[``firefox``], - link:https://apps.fedoraproject.org/packages/kde-baseapps[``kde-baseapps``](konqueror), - link:https://apps.fedoraproject.org/packages/thunderbird[``thunderbird``], - link:https://apps.fedoraproject.org/packages/evolution[``evolution``], - link:https://apps.fedoraproject.org/packages/kdepim[``kdepim``](kmail). + (link:https://src.fedoraproject.org/rpms/gnome-packagekit[``gnome-packagekit``], + link:https://src.fedoraproject.org/rpms/apper[``apper``]) +* Major desktop productivity apps. + An initial list would be + link:https://src.fedoraproject.org/rpms/firefox[``firefox``], + link:https://src.fedoraproject.org/rpms/kde-baseapps[``kde-baseapps``](konqueror), + link:https://src.fedoraproject.org/rpms/thunderbird[``thunderbird``], + link:https://src.fedoraproject.org/rpms/evolution[``evolution``], + link:https://src.fedoraproject.org/rpms/kdepim[``kdepim``](kmail). Changes to this definition may only be made by xref:index.adoc[FESCo] or their delegate. @@ -376,10 +377,10 @@ hardware music players, cell phones, etc. These packages may also be updated to devices or formats in compatible ways. Examples of this type of package: -link:https://apps.fedoraproject.org/packages/libopenraw[``libopenraw``], -link:https://apps.fedoraproject.org/packages/libimobiledevice[``libimobiledevice``], -link:https://apps.fedoraproject.org/packages/calibre[``calibre``], -link:https://apps.fedoraproject.org/packages/pilot-link[``pilot-link``] +link:https://src.fedoraproject.org/rpms/libopenraw[``libopenraw``], +link:https://src.fedoraproject.org/rpms/libimobiledevice[``libimobiledevice``], +link:https://src.fedoraproject.org/rpms/calibre[``calibre``], +link:https://src.fedoraproject.org/rpms/pilot-link[``pilot-link``] [[database-packages]] ==== Database packages @@ -391,8 +392,8 @@ changes to require a new version of the rules engine, then the package may be a rebasing. Examples of this type of package: -link:https://apps.fedoraproject.org/packages/spamassassin[``spamassassin``], -link:https://apps.fedoraproject.org/packages/clamav[``clamav``] +link:https://src.fedoraproject.org/rpms/spamassassin[``spamassassin``], +link:https://src.fedoraproject.org/rpms/clamav[``clamav``] [[examples]] ==== Examples From 6f0cacc498187d2218beae9bb3b2e2ce86c9e1a9 Mon Sep 17 00:00:00 2001 From: FeRD (Frank Dana) Date: Aug 26 2020 05:08:04 +0000 Subject: [PATCH 3/5] Semantic newlines for MUST/OR/AND statements --- diff --git a/fesco/modules/ROOT/pages/Updates_Policy.adoc b/fesco/modules/ROOT/pages/Updates_Policy.adoc index 287058d..4852f9f 100644 --- a/fesco/modules/ROOT/pages/Updates_Policy.adoc +++ b/fesco/modules/ROOT/pages/Updates_Policy.adoc @@ -108,14 +108,18 @@ and getting major testing. Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] -From this point onwards Maintainers **MUST**footnote:enforced[_Must_ requirements are enforced by Bodhi.]: +From this point onwards Maintainers +**MUST**footnote:enforced[_Must_ requirements are enforced by Bodhi.]: * Push all updates first to updates-testing. -* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates *MUST* either get - one +1 karma, *OR* spend at least 14 days in updates-testing and have no negative karma before being - moved to stable. -* All non critical path updates *MUST* either reach the prescribed karma level for that update, OR - spend at least 3 days in updates-testing before being allowed to move to stable. +* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates + *MUST* either get one +1 karma, + *OR* spend at least 14 days in updates-testing and have no negative karma + before being moved to stable. +* All non critical path updates + *MUST* either reach the prescribed karma level for that update, + *OR* spend at least 3 days in updates-testing + before being allowed to move to stable. and Maintainers *SHOULD* (not enforced): @@ -157,10 +161,14 @@ From this point onwards maintainers **MUST**footnote:enforced[]: * Avoid Major version updates, ABI breakage or API changes if at all possible. * Push updates first to updates-testing. * All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] - updates *MUST* either have a sum of +2 karma, - *OR* spend at least 14 days in updates-testing and have no negative karma. -* All non critical path updates *MUST* either reach the prescribed karma level for that update, - *OR* spend at least 7 days in updates-testing before being allowed to go to stable. + updates + *MUST* either have a sum of +2 karma, + *OR* spend at least 14 days in updates-testing + and have no negative karma. +* All non critical path updates + *MUST* either reach the prescribed karma level for that update, + *OR* spend at least 7 days in updates-testing + before being allowed to go to stable. [[pre-release]] === Pre release @@ -182,15 +190,19 @@ link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testin During this period: -* All updates pulled into the release **MUST**footnote:enforced[] fix an accepted blocker - or freeze exception bug. +* All updates pulled into the release + **MUST**footnote:enforced[] fix an accepted blocker or freeze exception bug. * All update pushes will go to updates-testing. -* All link:https://fedoraproject.org/wiki/Critical_path_package[ critical path] updates *MUST* either - have a sum of +2 karma, *OR* spend at least 14 days in updates-testing and have no negative karma. -* All non critical path updates *MUST* either reach the prescribed karma level for that update, *OR* - spend at least 7 days in updates-testing before being allowed in stable. +* All link:https://fedoraproject.org/wiki/Critical_path_package[critical path] updates + *MUST* either have a sum of +2 karma, + *OR* spend at least 14 days in updates-testing and have no negative karma. +* All non critical path updates + *MUST* either reach the prescribed karma level for that update, + *OR* spend at least 7 days in updates-testing + before being allowed in stable. * Once the _updates_ repository is available, builds marked as - link:https://fedoraproject.org/wiki/Repositories#stable[_stable_] will go there instead of to + link:https://fedoraproject.org/wiki/Repositories#stable[_stable_] + will go there instead of to link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_]. [[stable-releases]] @@ -228,14 +240,17 @@ link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testin [[updates-to-critical-path-packages]] === Updates to 'critical path' packages -Updates that constitute a part of the 'critical path' package set (defined -below) *including security updates* *MUST* follow the rules as defined for -link:https://fedoraproject.org/wiki/Critical_path_package[critical path packages] for -pending releases, meaning: +Updates that constitute a part of the 'critical path' package set +(defined below) *including security updates* +*MUST* follow the rules as defined for +link:https://fedoraproject.org/wiki/Critical_path_package[critical path packages] +for pending releases, meaning: * At the time of the request to stable, the update needs to have either a - link:https://fedoraproject.org/wiki/Bodhi[Bodhi karma] sum of 2 *OR* -* It must spend at least 14 days in updates-testing *AND* have no negative + link:https://fedoraproject.org/wiki/Bodhi[Bodhi karma] + sum of 2 *OR* +* It must spend at least 14 days in updates-testing + *AND* have no negative link:https://fedoraproject.org/wiki/Bodhi[Bodhi karma] points. For the purposes of this policy, the 'critical path' package set is defined as the following: @@ -274,8 +289,8 @@ Package maintainers *MUST*: Package maintainers *SHOULD*: -* Push *only* major bug fixes and security fixes to the previous stable releases (i.e., at present, - and before). +* Push *only* major bug fixes and security fixes to the previous stable releases + (i.e. the current Fedora _N_, and the previous Fedora _N-1_). [[exceptions]] === Exceptions From ee442e943ae2dfde0d50adf0637d81c840f555a9 Mon Sep 17 00:00:00 2001 From: FeRD (Frank Dana) Date: Aug 26 2020 05:08:22 +0000 Subject: [PATCH 4/5] 'onwards' (not a word) => 'onward' --- diff --git a/fesco/modules/ROOT/pages/Updates_Policy.adoc b/fesco/modules/ROOT/pages/Updates_Policy.adoc index 4852f9f..18f2e0d 100644 --- a/fesco/modules/ROOT/pages/Updates_Policy.adoc +++ b/fesco/modules/ROOT/pages/Updates_Policy.adoc @@ -72,7 +72,7 @@ builds submitted by packagers are considered link:https://fedoraproject.org/wiki/Repositories#stable[stable] immediately, and sent to the link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_ repository] directly in the next nightly compose. There are no restrictions beyond those for Rawhide at this point, but maintainers *SHOULD* be -thinking about stabilization from this point onwards, and making sure their packages will be in good +thinking about stabilization from this point onward, and making sure their packages will be in good condition well in advance of the stable release. Some packages will be signed at this point, but not all of them. You may have to use `--nogpgcheck` to install or update. @@ -108,7 +108,7 @@ and getting major testing. Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] -From this point onwards Maintainers +From this point onward Maintainers **MUST**footnote:enforced[_Must_ requirements are enforced by Bodhi.]: * Push all updates first to updates-testing. @@ -156,7 +156,7 @@ freeze is the state it will be in for the final release. Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] -From this point onwards maintainers **MUST**footnote:enforced[]: +From this point onward maintainers **MUST**footnote:enforced[]: * Avoid Major version updates, ABI breakage or API changes if at all possible. * Push updates first to updates-testing. From 6e8f81b6b2e83ae0e95562a0292a247505efcf33 Mon Sep 17 00:00:00 2001 From: FeRD (Frank Dana) Date: Aug 26 2020 06:13:34 +0000 Subject: [PATCH 5/5] Semantic newlines, copyedits - Capitalize several 'Fedora's - Add serial commas - 'bases' => 'basis' - Consistently end 'etc.' with a period --- diff --git a/fesco/modules/ROOT/pages/Updates_Policy.adoc b/fesco/modules/ROOT/pages/Updates_Policy.adoc index 18f2e0d..5cdea8b 100644 --- a/fesco/modules/ROOT/pages/Updates_Policy.adoc +++ b/fesco/modules/ROOT/pages/Updates_Policy.adoc @@ -36,7 +36,7 @@ see link:https://docs.fedoraproject.org/en-US/rawhide-gating/optin/[Rawhide Gati For updates to rawhide packages, Maintainers SHOULD: -* Try not to push a broken build (breaks the default buildroot package set, etc). +* Try not to push a broken build (breaks the default buildroot package set, etc.). * When a proposed update contains an ABI or API change: notify *a week in advance* both the link:https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/[devel list] and maintainers directly (using the ``_packagename_-\owner@fedoraproject.org`` alias) @@ -85,10 +85,11 @@ At the _Bodhi enabling point_, the Bodhi update system is enabled for the Branch this point *for the entire remaining lifetime of the release*, all updates must go through Bodhi before they can be marked _stable_ and moved to either link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] or -link:https://fedoraproject.org/wiki/Repositories#updates[_updates_]. At present, the _Bodhi enabling -point_ occurs on the day of the link:https://fedoraproject.org/wiki/Milestone_freezes[Beta freeze], but -it is important to remember that they are distinct events: the Beta freeze lasts until Beta release, -but Bodhi enabling is permanent. +link:https://fedoraproject.org/wiki/Repositories#updates[_updates_]. +At present, the _Bodhi enabling point_ occurs on the day of the +link:https://fedoraproject.org/wiki/Milestone_freezes[Beta freeze], +but it is important to remember that they are distinct events: +the Beta freeze lasts until Beta release, but Bodhi enabling is permanent. Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] @@ -134,24 +135,26 @@ _Alpha freeze_ and _Beta freeze_. Each is scheduled to run for the two weeks lea the release date (and in fact lasts until the release is signed off, even if it is delayed). During these times, builds will not be marked _stable_ and moved from link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] to -link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] (and hence included in the milestone -release composes) except for those approved under the Fedora QA team +link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] +(and hence included in the milestone release composes) except for those approved under the Fedora QA team link:https://fedoraproject.org/wiki/QA:SOP_blocker_bug_process[blocker bug process] or link:https://fedoraproject.org/wiki/QA:SOP_freeze_exception_bug_process[freeze exception bug process]. Once the milestone release is made, these freezes are lifted. -These freezes are technically not a part of the Updates Policy, but are briefly mentioned here for -clarity. The link:https://fedoraproject.org/wiki/Milestone_freezes[Milestone freezes] page provides more -details and is the canonical reference in case of any conflict. +These freezes are technically not a part of the Updates Policy, +but are briefly mentioned here for clarity. +The link:https://fedoraproject.org/wiki/Milestone_freezes[Milestone freezes] +page provides more details and is the canonical reference in case of any conflict. [[beta-to-pre-release]] === Beta to Pre Release This is the time between the Beta release and the -link:https://fedoraproject.org/wiki/Milestone_freezes[Final freeze]. The branched tree should now be -stabilized and prepared for release. Major changes should be avoided during this period. Bear in -mind that in most cases, the state your package has reached in the stable -link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] repository at the time of the Final -freeze is the state it will be in for the final release. +link:https://fedoraproject.org/wiki/Milestone_freezes[Final freeze]. +The branched tree should now be stabilized and prepared for release. +Major changes should be avoided during this period. +Bear in mind that in most cases, the state your package has reached in the stable +link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_] +repository at the time of the Final freeze is the state it will be in for the final release. Repos available: link:https://fedoraproject.org/wiki/Repositories#fedora[_fedora_], link:https://fedoraproject.org/wiki/Repositories#updates-testing[_updates-testing_] @@ -173,8 +176,8 @@ From this point onward maintainers **MUST**footnote:enforced[]: [[pre-release]] === Pre release -This is the time after the link:https://fedoraproject.org/wiki/Milestone_freezes[Final freeze]. During -this time the release is being composed and only packages granted exceptions through the +This is the time after the link:https://fedoraproject.org/wiki/Milestone_freezes[Final freeze]. +During this time the release is being composed and only packages granted exceptions through the link:https://fedoraproject.org/wiki/QA:SOP_blocker_bug_process[blocker bug process] or link:https://fedoraproject.org/wiki/QA:SOP_freeze_exception_bug_process[freeze exception bug process] are marked as _stable_ and moved to the @@ -283,7 +286,7 @@ All other updates *MUST* either: Package maintainers *MUST*: -* Avoid Major version updates, ABI breakage or API changes if at all possible. +* Avoid Major version updates, ABI breakage, or API changes if at all possible. * Avoid changing the user experience if at all possible. * Avoid updates that are trivial or don't affect any Fedora users. @@ -310,18 +313,18 @@ Things that would make it more likely to grant a request: * The package is a "leaf" node. Nothing depends on it or requires it. * The update fixes a security issue that would affect a large number of users. * The update doesn't change ABI/API and nothing needs to be rebuilt against the new version. -* The update fixes serious bugs that many fedora users are encountering. +* The update fixes serious bugs that many Fedora users are encountering. Things that would make it less likely to grant a request: * The update converts databases or resources one way to a new format. -* The update requires admin intervention for the service to keep working (config file format - changes, etc) -* The update causes behavior changes (something that was denied is allowed, etc) -* The update changes the UI the end user sees (moves menus or buttons around, changes option names - on command line) -* The update fixes bugs that no fedora user has reported nor would affect many fedora users (i.e., - fixes for other platforms or configurations). +* The update requires admin intervention for the service to keep working + (config file format changes, etc.) +* The update causes behavior changes (something that was denied is allowed, etc.) +* The update changes the UI the end user sees + (moves menus or buttons around, changes option names on command line) +* The update fixes bugs that no Fedora user has reported nor would affect many Fedora users + (i.e., fixes for other platforms or configurations). [[exceptions-list]] ==== Exceptions list @@ -353,9 +356,9 @@ See link:https://pagure.io/fesco/issue/1255[this FESCo ticket]. [[security-fixes]] ==== Security fixes -If upstream does not provide security fixes for a particular release, and if backporting the fix -would be impractical, then the package maintainer(s) *MUST* open a FESCo ticket for approval to rebase -the package to a version that upstream supports. +If upstream does not provide security fixes for a particular release, +and if backporting the fix would be impractical, then the package maintainer(s) +*MUST* open a FESCo ticket for approval to rebase the package to a version that upstream supports. Package maintainers *MUST*: @@ -434,23 +437,28 @@ link:https://src.fedoraproject.org/rpms/clamav[``clamav``] changes are (removing the File menu would be rude, but moving the plugin configuration menu item would be acceptable). -* Firefox releases an update that only contains changes for other platforms. This update could be - pushed to rawhide (to keep up with the latest version), but should not be pushed to stable - releases, as it does no good to our users and wastes resources to build, update, mirror and - download to our users. -* Terminal fails to build from source when tested in a mass rebuild. An updated package should be - pushed to rawhide. Fixes for stable releases should be tested and even committed, but unless there - is a problem with the previous existing build in the stable release, no update should be issued. +* Firefox releases an update that only contains changes for other platforms. + This update could be pushed to rawhide (to keep up with the latest version), + but should not be pushed to stable releases, as it does no good to our users + and wastes resources to build, update, mirror, and download to our users. + +* Terminal fails to build from source when tested in a mass rebuild. + An updated package should be pushed to rawhide. + Fixes for stable releases should be tested and even committed, + but unless there is a problem with the previous existing build in the stable release, + no update should be issued. This update would not change any user facing functions of the package. -* KDE upstream releases a new major version, and at the same time stops supporting the older release - that is in Fedora N and Fedora N-1. This release includes a large number of bugfixes, mixed with - enhancements and security fixes. An exception for this type of update would need to consider: - ability to backport major fixes/security issues, type and amount of bugs fixed, ability to not - update other parts of fedora for this update (i.e., avoid Qt or other base library ABI changes), - amount of testing and end user visible changes. An exception like this would be on a case by case - bases based on all the above. +* KDE upstream releases a new major version, + and at the same time stops supporting the older release that is in Fedora N and Fedora N-1. + This release includes a large number of bugfixes, mixed with enhancements and security fixes. + An exception for this type of update would need to consider: + ability to backport major fixes/security issues, + type and amount of bugs fixed, + ability to not update other parts of Fedora for this update (i.e., avoid Qt or other base library ABI changes), + amount of testing and end user visible changes. + An exception like this would be on a case by case basis, based on all the above. [[problems-or-issues-with-updates]] == Problems or issues with Updates @@ -489,11 +497,11 @@ tests, please check the result and fix the problem. If you are sure there is an test rather than an error in your package, you may still manually push the update or re-enable karma automatism. -Previously, the old AutoQA system ran similar checks to Taskotron. The scope of these automated -checks is expected to expand in future. The -link:https://fedoraproject.org/wiki/QA:Package_Update_Acceptance_Test_Plan[Package Update Acceptance Test Plan] -was written as the original -plan for AutoQA update validation, and may still be seen as a framework for future work on Taskotron. +Previously, the old AutoQA system ran similar checks to Taskotron. +The scope of these automated checks is expected to expand in future. +The link:https://fedoraproject.org/wiki/QA:Package_Update_Acceptance_Test_Plan[Package Update Acceptance Test Plan] +was written as the original plan for AutoQA update validation, +and may still be seen as a framework for future work on Taskotron. [[bodhi-use]] == Bodhi Use