From Fedora Project Wiki

(Replaced content with "{{admon/warning |This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Pack...")
Tag: Replaced
 
Line 1: Line 1:
{{autolang|base=yes}}
+
{{admon/warning |This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Package_Update_GuidePlease update your bookmarks.}}
 
 
This document shows how to submit an update for a package you maintain in Fedora.  It assumes you already have a package in the Fedora repositories. It is not a guide to using the Fedora package source control system: see the [[Package maintenance guide]] for that.
 
 
 
* For details of the policy on requirements for updates at various stages of the [[Fedora Release Life Cycle]], refer to the [https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/ Updates Policy].
 
 
 
== Overview ==
 
 
 
This page is intended for new and existing package maintainers. Testers and regular users may be interested in the [[QA:Updates_Testing|updates-testing]] repository and the [[QA:Update_feedback_guidelines|update feedback guidelines]]. This page specifically covers the update submission process.
 
 
 
There are two significantly different package update submission workflows in Fedora:
 
 
 
* [[Releases/Rawhide|Rawhide]], and [[Releases/Branched|Branched]] up to the [https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/#bodhi-enabling Bodhi enabling point]
 
* [[Releases/Branched|Branched]] releases after the Alpha change deadline, and stable releases
 
 
 
The repository layouts differ somewhat for Rawhide, Branched and stable releases, but the update workflows split up as described above.
 
 
 
== Rawhide and early Branched ==
 
 
 
=== Single Packages ===
 
 
 
The update workflow for single package builds in Rawhide and Branched before the ''Bodhi enabling point'' is simple:
 
 
 
# Build the package with {{command|fedpkg build}} (see the [[Package maintenance guide]] for more details)
 
 
 
This is all you need to do, a Bodhi update will be created automatically, from which potential tests will be run.
 
 
 
* If the built package doesn't have tests, or if they succeed, the update will be marked as ''stable'' and your package will appear in subsequently created build roots, as well as in the next daily compose of Rawhide or Branched and will be used in any image composes built from that tree.
 
 
 
* If the built package has tests which fail, this will be recorded in the update. You can now either [[#Waive_a_result|waive the failing tests]] if you're sure that the test shouldn't fail, or fix whatever is wrong with the package, build it again, which in turn will create an update, running the tests (on the now hopefully fixed package), and so forth.
 
 
 
=== Multiple Packages ===
 
 
 
Some updates require changes in multiple related packages, e.g. if a library is upgraded to a new major version and packages using it need to be rebuilt.
 
 
 
Fedora has the concept of using side-tags for these situations, which means the builds are done "on the side" and do not affect packages out of the side-tag, nor are they available for installing until the side-tag is merged. Packagers can create side-tags on their own, allowing them to build disruptive components in isolation and submit the builds in a side-tag as one update in Bodhi, to be tested and subsequently merged into the main distribution.
 
 
 
==== Creating a side-tag ====
 
 
 
To create a side-tag for building packages for Rawhide, the easiest way is to be in the checked out <code>rawhide</code> branch of one of the packages and issue the following command:
 
 
 
fedpkg request-side-tag
 
 
 
Alternatively, you can specify the parent/base tag from which to create the side-tag, e.g.:
 
 
 
fedpkg request-side-tag --base-tag f32-build
 
 
 
{{admon/note|Parent/Base Tags|
 
 
 
Side-tags for particular Fedora releases are based off its respective build tag. I.e. if you wanted to create a side-tag for Rawhide while it's ramping up for Fedora 32, the parent tag to choose would be <code>f32-build</code>.
 
 
 
}}
 
 
 
This will tell you the commands to 1) build a package in the specific side-tag and 2) wait for the respective build root to be recreated, e.g.:
 
 
 
$ fedpkg request-side-tag --base-tag f32-build
 
Side tag 'f32-build-side-7863' (id 7863) created.
 
Use 'fedpkg build --target=f32-build-side-7863' to use it.
 
Use 'koji wait-repo f32-build-side-7863' to wait for the build repo to be generated.
 
$
 
 
 
The latter is important if any builds depend on previous ones in the side-tag. Use `koji wait-repo --build <package-nvr> <side-tag>` to ensure that the respective build is available in the build root for subsequent builds.
 
 
 
==== Bodhi update for builds in a side-tag ====
 
 
 
When you're done building all packages you want in a side-tag, you have to submit them as an update to Bodhi before they can be made available generally to be installed and built upon.
 
 
 
<!-- Using the Web UI -->
 
In the "Create New Update" form in Bodhi, choose the "Use Side-Tag" drop-down to create an update from the latest package builds in the respective tag:
 
 
 
[[File:Bodhi-builds-from-side-tag.png]]
 
 
 
As with single packages, tests will be run whose result affects if the update can be moved to stable. The difference is that tests have to succeed (or be waived) for all builds in the update. If you have to update the list of builds, e.g. to fix problems found during testing, edit the update and refresh the list of builds using the 🔃 (refresh) button:
 
 
 
[[File:Bodhi-builds-refresh-from-side-tag.png]]
 
 
 
The web interface only works if you are the creator of the side-tag. If you are a proven packager submitting an update for a side-tag, you currently need to use the bodhi cli:
 
 
 
  $ bodhi updates new --from-tag <sidetagname> --notes "whatever"  --user <FAS>
 
 
 
{{admon/note|Adding/Removing builds to/from a side-tag|
 
 
 
As a packager you can add or remove builds from your side-tag, this can be achieved using these commands:
 
 
 
$ koji tag <side-tag> <nvr>
 
$ koji untag <side-tag> <nvr>
 
 
 
This can be used to remove a build that made a test fail or to add a build that was originally missed. If you add or remove a build from a side-tag, you will have to refresh the corresponding update in bodhi.
 
}}
 
 
 
Once the update moves to stable, the builds will be tagged to the main tag of the release, i.e. are available for the general public.
 
 
 
== Later Branched and stable releases ==
 
 
 
At the [https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/#bodhi-enabling Bodhi enabling point], the [[Bodhi]] update feedback system is enabled by [[ReleaseEngineering|Release Engineering]] and builds submitted with {{command|fedpkg build}} are no longer automatically sent to any official [[Repositories|repository]]. The update workflow for releases of this type is:
 
 
 
{{admon/tip|Fedora account name|{{command|fedpkg}} should be able to discover your [[Account_System|Fedora account system]] user name from the {{filename|~/.fedora.cert}} file set up by {{command|fedora-packager-setup}} when you first [[Join_the_package_collection_maintainers#Install_the_client_tools_.28Koji.29_and_set_up_your_certificate|configured your system for packaging]]. If this fails for any reason, you can specify it with {{command|--user (username)}}. For the {{command|bodhi}} command line tool, you may need to specify your Fedora user name with {{command|--user (username)}} if it differs from your system user name.}}
 
 
 
# Build the package with {{command|fedpkg build}}
 
# Submit an update for the package with {{command|fedpkg update}}, the [https://admin.fedoraproject.org/updates/ Bodhi web interface], or the [https://fedorahosted.org/bodhi/wiki/CLI Bodhi CLI tool]. This causes the package to be sent to the [[Repositories#updates-testing|''updates-testing'']] repository
 
# Monitor the update's status and the feedback you receive via the web interface or the emails that are sent to you, and modify it with updated or additional builds if necessary
 
# After the update meets the criteria in the [https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/ Updates Policy]  and you are satisfied it should be released as a stable update, submit the update to ''[[Repositories#stable|stable]]'' with {{command|bodhi updates request <update_id> stable}} or the web interface
 
 
 
{{admon/important|Updating inter-dependent packages|If a package you wish to update requires other package(s) to be rebuilt before it or they will work properly, you '''must''' submit the builds together as a multi-package update. See [[#multi|below]] for more details on this.}}
 
 
 
=== Update attributes ===
 
 
 
At the time you submit the update, you will be asked for several attributes. The type of the update should be fairly self-explanatory: either it fixes bugs, adds new features, or is a new package.
 
 
 
If you are asked whether you want to send the update to ''updates-testing'' or ''stable'', this is a no-op: all updates now go through ''updates-testing''. It does not matter what you choose.
 
 
 
There are several schools of thought on filling out the update description. Some would suggest you consider the target audience: for a stable release, in particular, many Fedora users will see this text, and many of them may not be particularly familiar with your package. Consider not simply describing literally the changes in the update, but explaining as if to an outsider why your are updating the package, what benefits it will bring to them (if any), and anything they may want to note in order to have a smooth update experience.
 
 
 
If you associate one or more bug reports with your update, Bodhi will post comments into Bugzilla to alert those following the bug reports that an update is available. If you mark your update as fixing the bug(s), Bodhi will move the report(s) through the '''MODIFIED''', '''ON_QA''' and '''CLOSED ERRATA''' states of the [[BugZappers/BugStatusWorkFlow|bug workflow]] as your update reaches various points in the process. Using this mechanism can be very useful both for you and for users of your package.
 
 
 
You may set a ''karma'' (feedback) level at which the update will automatically be submitted to ''stable''. This is optional. If you choose to use it, please carefully consider an appropriate feedback level. For a relatively obscure package which is quite stable, 1 or 2 may be an appropriate value. For a popular, sensitive and complex package such as {{package|firefox}} or the {{package|kernel}}, the default of 3 may be insufficient and a choice of 5 or even 10 may be appropriate.
 
 
 
=== Who will receive your update, when? ===
 
 
 
When a release is in Branched state, the ''updates-testing'' repository is enabled by default so most users will see the package, but only packages from the stable ''fedora'' repository are used in building milestone releases (Alpha, Beta and Final) and nightly images.
 
 
 
Where a package goes when it is marked as ''stable'' differs between Branched and stable releases. In Branched releases, ''stable'' packages are pushed to the base ''fedora'' repository. In stable releases, ''stable'' packages are pushed to the ''updates'' repository. However, from the point of view of the packager, this is an insignificant implementation detail. For more details, see [[Repositories]].
 
 
 
When a release is in stable state, the ''updates-testing'' repository is disabled by default, but [[QA]] team members and others run with it enabled in order to provide testing and Bodhi feedback. The main user population will see your update only when it passes Bodhi, is marked as ''stable'' and reaches the ''updates'' repository.
 
 
 
{{anchor|multi}}
 
=== Updating inter-dependent packages ===
 
 
 
If an update you wish to submit would cause a dependency issue of any kind (a strict package dependency error, or simply another package failing to operate correctly) if updated alone, you must not submit the package as a single-package update. You must always collect all inter-dependent or related packages together into a single multi-package update, such that no user will face problems if they install all the packages in the update together.
 
 
 
For example: if you maintain a package ''libfoo'' which the package ''bar'' depends on, and you need to update ''libfoo'', you should check that ''bar'' continues to function correctly with the updated version of ''libfoo''. If it does not, you must ensure the appropriate changes are made to ''bar'', and include the updated ''bar'' in your update along with the updated ''libfoo''.
 
 
 
The ''fedpkg'' tool does not handle multi-package updates. You can add multiple packages to an update using the [https://bodhi.fedoraproject.org/updates/new Bodhi web application], or the {{command|bodhi}} command line tool. You can pass as many package names as you like to the {{command|bodhi updates new}} to create a new multi-package update, or use {{command|bodhi updates edit}} to edit an existing update.
 
 
 
It is possible you will run into problems with permissions when trying to add builds of packages you do not have commit privileges for to an update, or trying to add a build for a package you do have privileges for to someone else's update. If you encounter a situation like this, you should contact the [[ReleaseEngineering|release engineering]] team or a proven packager for help.
 
 
 
You may need a ''buildroot override'' to complete a multi-package update successfully. For instance in the case described above, you may need to rebuild ''bar'' against the new ''libfoo'' package and submit both packages together as a multi-package update. However, in the normal course of events, you would not be able to build another package against your new ''libfoo'' build until it reached the [[Repositories#stable|''stable'']] state. To resolve this dilemma, you can request a buildroot override, which causes the ''libfoo'' build to be included in the buildroot for a short time in order to get the ''bar'' package build done.
 
 
 
You can request a buildroot override with bodhi: {{command|bodhi overrides save (name-version-release) --duration 2 --notes "Useful details."}} This would submit a buildroot override with a duration of two days. Buildroot overrides are usually granted within 15-30 minutes of submission. If you submit an override request with the bodhi tool, it will suggest a command that will let you monitor when the package appears in the buildroot, so you can fire your dependent build at the appropriate time: <code>koji wait-repo f34-build --build=(name-version-release)</code>
 
 
 
You can also request buildroot overrides from the [https://bodhi.fedoraproject.org/overrides/new Bodhi web application].
 
 
 
The [[Bodhi/BuildRootOverrides|buildroot override instructions]] explain the buildroot override process in more detail.
 
 
 
=== Handling feedback from automated tests ===
 
 
 
Fedora's automated testing systems, [[Taskotron]] and [[OpenQA]], may run automated tests on your update. Several of the [[Taskotron/Tasks]] are documented. The openQA tests are functional tests of some critical [[Workstation]] and [[Server]] features.
 
 
 
In the Bodhi web interface, updates have a ''Automated Tests'' tab which displays the results of all automated tests. Tests shown with a red background failed. The tests are not all 100% accurate, but they are fairly often correct. If you see a failure, it is a very good idea to click on the result (which will take you to a detailed log) and investigate the issue. If you are unsure what the test indicates, you can contact the [[QA]] team for help.
 
 
 
==== Waive a result ====
 
 
 
At present, a failure of the ''dist.rpmdeplint'', ''dist.abicheck'', or ''org.centos.prod.ci.pipeline.complete'' tests will prevent your update from being released. On the update's ''Details'' page in the Bodhi web interface, the '''Test Gating Status''' will be shown as ''N of N required tests failed''. If you are sure such a failure is a false one, you can 'waive' the result using the {{code|waiverdb-cli}} tool, from the {{package|waiverdb-cli}} package (there is [https://github.com/fedora-infra/bodhi/pull/2095 work pending] to be able to waiver more easily, directly from the Bodhi UI).
 
 
 
You can submit a waiver for a failing result with {{pkg|waiverdb-cli}} specifying the {{code|subject}} and the {{code|testcase}}:
 
 
 
  waiverdb-cli -t YOUR_TESTCASE_HERE -s '{"item": "this-is-the-subject", "type": "also-this-is-part-of-the-subject"}' -p "fedora-26" -c "This is fine"
 
 
 
Example:
 
 
 
  waiverdb-cli -t dist.rpmdeplint -s '{"item": "python-requests-1.2.3-1.fc26", "type": "koji_build"}' -p "fedora-26" -c "This is fine"
 
 
 
You can also waive a failing result by result's id, which you can retrieve from resultsdb with curl.  To do that, you'll need the {{code|testcase}} name and the {{code|nvr}}.  For example:
 
 
 
  curl "https://taskotron.fedoraproject.org/resultsdb_api/api/v2.0/results?testcases=dist.python-versions&item=python-alembic-0.9.7-1.fc27" | jq ".data[0].id"
 
 
 
This should print out the {{code|result_id}} of the failing result.  You can then submit a waiver for this failing result with {{pkg|waiverdb-cli}}
 
 
 
  waiverdb-cli -p fedora-27 -r YOUR_ID_HERE -c "This is fine."
 
 
 
Also, if you enabled automatic stable push at a karma threshold, this will be disabled if any automated test fails. If you have examined the result and you are sure it is a false one and there is no problem with the package, you may re-enable the automatic push mechanism or submit the package to ''stable'' manually once it meets the other requirements of the [https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/ Updates Policy].
 
 
 
==== Waive the absence of a result ====
 
 
 
Submitting a waiver using subject/testcase allows to waive the absence of a result (e.g. the test never ran for some reason, so there is no result item).
 
 
 
If which testcase you should be specified it is not clear/known, it is possible to run this python script, changing it with the corrects parameter:
 
 
 
#!/usr/bin/env python
 
""" Ask a question of greenwave.  """
 
# Usage: either modify and set PRODUCT_VERSION and NVR_LIST and run, or pass version as first arg and then NVRs as further args
 
import pprint
 
import requests
 
import sys
 
  PRODUCT_VERSION = 'fedora-27' if len(sys.argv) == 1 else sys.argv[1]
 
NVR_LIST = [] or sys.argv[2:]  # Insert your NVRs here, or pass them via command line args
 
for nvr in NVR_LIST:
 
    url = (
 
        'https://greenwave-web-greenwave.app.os.fedoraproject.org/'
 
        'api/v1.0/decision')
 
    payload = dict(
 
        #verbose=True,
 
        decision_context='bodhi_update_push_stable',
 
        product_version=PRODUCT_VERSION,
 
        subject=[{'item': nvr, 'type': 'koji_build'}],
 
    )
 
    response = requests.post(url, json=payload)
 
    print("-" * 40)
 
    print(nvr, response, response.status_code)
 
    data = response.json()
 
    print(pprint.pformat(data))
 
 
 
The output will show that Greenwave is requiring a specific testcase to run, but it cannot find a result for it (neither pass nor failure). So now it is possible to submit a waiver with the specified testcase in the output and the subject already known.
 
 
 
==== Troubleshooting ====
 
 
 
If you run the {{code|waiverdb-cli}} tool and it gives you the following error:
 
 
 
  Error: The config option "resultsdb_api_url" is required
 
 
 
Edit {{code|/etc/waiverdb/client.conf}} and add the following line:
 
 
 
  resultsdb_api_url=https://taskotron.fedoraproject.org/resultsdb_api/api/v2.0
 
 
 
=== Branched milestone freezes ===
 
 
 
For a short period before each milestone release, the stable [[Repositories#fedora|''fedora'']] repository is frozen. These periods are shown as the [[Milestone freezes]] (Beta Freeze, Final Freeze) on schedules. During these periods, builds will not be marked ''stable'' and pushed from [[Repositories#updates-testing|''updates-testing'']] to ''fedora'' even after being submitted manually or automatically. In the normal course of events, they will be pushed after the milestone release is approved at a [[Go_No_Go_Meeting]]. If you believe your update deserves to break a milestone freeze, a ''freeze exception'' may be granted through the [[QA:SOP_freeze_exception_bug_process|freeze exception process]]. Accepted release blocking bugs are granted the same status through the [[QA:SOP_blocker_bug_process|blocker bug process]].
 
 
 
For more on the Fedora development process, see [[Fedora Release Life Cycle]].
 
 
 
{{admon/tip|
 
If you are unsure whether your build is currently considered ''stable'' for a given release, you can check with {{command|koji latest-pkg fXX}} (where XX is the release).}}
 
 
 
== Security updates ==
 
 
 
There is an additional process that layers over the regular update process for bugs identified as security issues. If a bug is assigned to you that blocks a [[Security Tracking Bugs|security tracking bug]], you must follow that process in addition to this one.
 
 
 
== New package submissions ==
 
 
 
If you want to build a new package, but you aren't sure which releases to send it to:
 
 
 
* New packages should always be built for Rawhide
 
* New packages can be built for Branched and stable releases if adding them would provide value to users of those releases without significant risk of causing harm
 
 
 
The submission process for new packages, after they have passed the [[Package_Review_Process]] and been [[Package_SCM_admin_requests|given an SCM repository]], is exactly the same as that for package updates.
 
 
 
== Consider creating a package test plan ==
 
 
 
If you [[QA:SOP_test_case_creation|create test cases]] for your package, and [[QA:SOP_package_test_plan_creation|categorize them appropriately]], they will be automatically linked in Bodhi, so that testers will have some guidance for planned update testing.
 
 
 
[[Category:Package Maintainers]]
 

Latest revision as of 06:11, 7 September 2021

Warning.png
This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Package_Update_Guide/ Please update your bookmarks.