(Initial Draft) |
(Update rebase procedure for LLVM.) |
||
| Line 19: | Line 19: | ||
A rebase is an upgrade that changes the major version of LLVM (e.g. upgrading from X.0.1 to (X+1).0.0). For each upstream release we would like to start the upgrade process when the first release candidate is released. Packaging the first release candidate gives us a chance to test and fix issues in Fedora so we can get fixes back upstream before the final release. | A rebase is an upgrade that changes the major version of LLVM (e.g. upgrading from X.0.1 to (X+1).0.0). For each upstream release we would like to start the upgrade process when the first release candidate is released. Packaging the first release candidate gives us a chance to test and fix issues in Fedora so we can get fixes back upstream before the final release. | ||
=== Step 1: | === Step 1: File a System Wide Change Proposal === | ||
A [[Changes/Policy|Change Proposal]] should be filed to notify Fedora users and developers that LLVM will be rebased in the next Fedora release. Make sure to follow the Fedora release schedule and file the change proposal before the Change Checkpoint. | |||
% | === Step 2: Request a side tag === | ||
File a [https://pagure.io/releng/new_issue ticket] with releng to request a side tag for the initial package builds. | |||
[https://pagure.io/releng/issue/8569 Example] | |||
=== Step 3: Request dist-git repos for compatibility packages === | |||
Create a compatibility packages for clang and llvm for the current release in rawhide Using the `fedpkg request-repo` command. The packages should be called clangX.Y and llvmX.Y, where X.Y.z is the current version of LLVM in rawhide. | |||
Compatibility packages [[Packaging:ReviewGuidelines#Package_Review_Process|do not need a full package review]], so you can use the --exception flag when creating them. | |||
=== Step 4: Create the compatibility packages === | |||
You can re-use the existing spec files from the clang and llvm dist-git when creating the compatibility packages. You just need to change the compat_build option to enabled by default: | |||
%bacond_with compat_build -> %bcond_without compat_build | |||
=== Step 5: Do initial builds in the side tag === | |||
Do local or scratch builds of each llvm sub-project to make sure they build successfully in rawhide. Once you have confirmed that everything works, you can start submitting your builds to Koji. | |||
{{admon/warning|Pocl|Pocl has a runtime dependency on clang, so it needs to be rebuilt during the rebase process.}} | {{admon/warning|Pocl|Pocl has a runtime dependency on clang, so it needs to be rebuilt during the rebase process.}} | ||
The goal at this stage is to get builds into rawhide. It is OK to disable tests and ignore minor failures at this stage. | |||
=== Step 6: Merge side tag into rawhide === | |||
Comment on the releng ticket in Step 2 and ask for the side tag to be merged into rawhide. | |||
{{admon/note|It's very important to try to get the initial builds into rawhide before a new release is branched. This will give us the maximum possible time to integrate the new builds with other packages in Fedora.}} | |||
=== Step 7: Stabilize the packages === | |||
Continue to stabilize the packages in rawhide and any branched releases until all CI tests are passing and major bugs resolved. | |||
Revision as of 04:41, 27 September 2019
Overview
This guide is intended for packagers working with any of the llvm sub-projects, which include:
- llvm
- clang
- lld
- lldb
- python-lit
- libomp
- libcxx
- libcxxabi
General Development
Please submit pull requests for major changes. This will allow the CI tests to run and give other developers a chance to review.
CI Tests
The goal of the CI tests should be to test integration of llvm packages into the system. Tests for specific upstream bugs are not necessary, but any Fedora bugs that are caused by interactions with another package should have a CI test added when they are fixed.
Rebases
A rebase is an upgrade that changes the major version of LLVM (e.g. upgrading from X.0.1 to (X+1).0.0). For each upstream release we would like to start the upgrade process when the first release candidate is released. Packaging the first release candidate gives us a chance to test and fix issues in Fedora so we can get fixes back upstream before the final release.
Step 1: File a System Wide Change Proposal
A Change Proposal should be filed to notify Fedora users and developers that LLVM will be rebased in the next Fedora release. Make sure to follow the Fedora release schedule and file the change proposal before the Change Checkpoint.
Step 2: Request a side tag
File a ticket with releng to request a side tag for the initial package builds. Example
Step 3: Request dist-git repos for compatibility packages
Create a compatibility packages for clang and llvm for the current release in rawhide Using the fedpkg request-repo command. The packages should be called clangX.Y and llvmX.Y, where X.Y.z is the current version of LLVM in rawhide.
Compatibility packages do not need a full package review, so you can use the --exception flag when creating them.
Step 4: Create the compatibility packages
You can re-use the existing spec files from the clang and llvm dist-git when creating the compatibility packages. You just need to change the compat_build option to enabled by default:
%bacond_with compat_build -> %bcond_without compat_build
Step 5: Do initial builds in the side tag
Do local or scratch builds of each llvm sub-project to make sure they build successfully in rawhide. Once you have confirmed that everything works, you can start submitting your builds to Koji.
Pocl has a runtime dependency on clang, so it needs to be rebuilt during the rebase process.
The goal at this stage is to get builds into rawhide. It is OK to disable tests and ignore minor failures at this stage.
Step 6: Merge side tag into rawhide
Comment on the releng ticket in Step 2 and ask for the side tag to be merged into rawhide.
Step 7: Stabilize the packages
Continue to stabilize the packages in rawhide and any branched releases until all CI tests are passing and major bugs resolved.