No edit summary |
|||
Line 17: | Line 17: | ||
Make sure you have an account in [https://bugzilla.redhat.com/ Red Hat Bugzilla] . | Make sure you have an account in [https://bugzilla.redhat.com/ Red Hat Bugzilla] . | ||
The email address that you use for your bugzilla account should be the same email address as you use for all things related to Fedora Packaging. | The email address that you use for your bugzilla account should be the same email address as you use in the [[#Get_a_Fedora_Account| Fedora Account System]] for all things related to Fedora Packaging. | ||
=== Join the important Mailing Lists === | === Join the important Mailing Lists === |
Revision as of 16:26, 8 August 2008
How to join the Fedora Package Collection Maintainers?
So, you have decided to become a package maintainer in the Fedora Project? This guide will lead you through your first package submission.
Becoming a Fedora Package Collection Maintainer
Read the Guidelines
If you don't know how to create an RPM package, see the Creating Package HOWTO.
Read the Packaging Guidelines and Package Naming Guidelines .
You need to be thoroughly familiar with these. They govern all package submissions. If you have questions, ask on the Fedora Packaging List .
Create a Bugzilla Account
Make sure you have an account in Red Hat Bugzilla .
The email address that you use for your bugzilla account should be the same email address as you use in the Fedora Account System for all things related to Fedora Packaging.
Join the important Mailing Lists
You must join the fedora-devel-announce@redhat.com mailing list. It is a low traffic announcements only list, where important development information is posted.
You can join the fedora-devel-list@redhat.com mailing list, where discussions about the development of Fedora are held. This is a high traffic mailing list.
You can also consider joining the fedora-extras-commits@redhat.com mailing list -- The commits mailing list gets notifications on all commits in any package in the Fedora repository. This is a very high traffic mailing list. The Fedora package database sends commit mails for packages you (co-)maintain.
Another mailing list you might consider (at least to view the archives) is fedora-packaging@redhat.com. This is the mailing list of the Fedora Packaging Committee, who determine the official packaging guidelines for Fedora projects.
Read Other Submissions
Read some other package submissions to learn about packaging and gain familiarity with the process and requirements.
One way of doing this is to join the fedora-package-review@redhat.com mailing list ; all comments on Fedora package reviews are sent to this (read-only from your point of view) list.
Make a Package
You should make sure that it is a new package. The package you are submitting can be of any Free and open source project that is not already packaged in Fedora. You can find a list of existing packages in Fedora Package Collection in the Fedora Package Database . Please also check the In Progress Review Requests list of packages that are currently reviewed and the Retired Packages list.
- If you don't know how to create an RPM package, see the Creating Package HOWTO.
- Make sure that your package meets the Packaging Guidelines and PackageNamingGuidelines .
- Be aware of Forbidden Items and Package Review Guidelines (they will be used during the package review).
Upload Your Package
Upload your SRPM and SPEC files onto the Internet somewhere. This can be anywhere accessible by a URL.
Create Your Review Request
Fill out this form: https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&format=extras-review.
- Make sure that you put the name of the package (excluding version and release numbers) in the '
Review Summary
' field, along with a very brief summary of what the package is. - Upload the spec file and SRPM to a public website. If you need hosting space, please make a note of it in your ticket submission and someone will take care of you. If you are a Fedora package maintainer already, you can make use of http://fedorapeople.org
- Put a description of your package (usually, this can be the same thing as what you put in the spec %description) in the '
Review Description
' field. Include the URLs to your SRPM and SPEC files. Also, explain that this is your first package and you need a sponsor.
The review process is described in detail on the Package Review Process page.
Watch for Feedback
Watch the Bugzilla report for your first package. You should get notifications of changes by email. Fix any blockers that the reviewer(s) point out.
Get a Fedora Account
Create an account in the Fedora Account System (this is not just a bugzilla account)
- Visit the account system home: https://admin.fedoraproject.org/accounts/
- Click on 'New account' and fill in the blanks.
- After you create your account, please be sure to sign the CLA (if you click on the "My Account" link in the top right, you should see CLA: CLA Done)
Note: Red Hat employees should apply forcla_redhat
instead. From the Account System, Apply for a New Group, putcla_redhat
in the group field, and click Apply. Then ask TomCallaway to approve you. - Once you get email confirmation that your account has been created and you're a member of the
cla_done
group, return to edit your account: https://admin.fedoraproject.org/accounts/group/list?search=packager*- In the table, look for the
packager
group, and clickApply
under Status. - Once this is done, your account will show up as "pending" to all of the Fedora Package Collection sponsors (who will receive an email).
- When you are sponsored, you will be automatically added/approved to the fedorabugs group as well. This will allow you to make changes to the state of bugs in Bugzilla, which is what you'll need to do to get them checked in. It will also allow you to do complete package reviews, including approving packages yourself!
- In the table, look for the
Install the Client Tools (Koji)
fedora-packager provides tools to help you setup and work with fedora. To install fedora-packager run:
yum install fedora-packager
To build Packages for Fedora EPEL , you need Plague and for Fedora 7 and later (including devel) you need Koji .
You'll also need some certificates, for security:
- Generate a client side certificate: https://admin.fedoraproject.org/accounts/user/gencert . Then place the file in
~/.fedora.cert
, where the Fedora CVS configuration will look for it by default. - You'll also need two more certs:
- The certificate for the Certificate Authority used to sign the user keys, available from fedora-upload-ca.cert - save that as
~/.fedora-upload-ca.cert
- the certificate for the Certificate Authority used to sign the buildsystem's server keys, available from fedora-server-ca.cert - save that as
~/.fedora-server-ca.cert
- The certificate for the Certificate Authority used to sign the user keys, available from fedora-upload-ca.cert - save that as
After installation, as your user run fedora-packager-setup to setup your user environment. This will get you ready to use koji. (To use plague for EPEL follow the Plague instructions.) So, for Fedora, do this:
fedora-packager-setup
This is important. Without setting up your user environment (e.g., by running fedora-packager-setup), you won't be able to request package builds.
You can now use "koji" to try to build your RPM packages on platforms (e.g., PPC) or distributions don't have. Note that you can test out builds ("scratch" builds) even when your package hasn't been approved and you don't have a sponsor. A simple way to do a scratch build using koji is to do this at the command line:
koji build --arch-override=PLATFORM --scratch TARGET path_to_source_RPM
Where:
- TARGET is a distribution keyword such as dist-f9 (for Fedora 9). You can run "koji list-targets" to see all targets
- PLATFORM is a platform keyword such as i386 (32-bit), x86_64, ppc, or ppc64. You can omit --arch-override=PLATFORM, in which case koji will do test builds on all the architectures the spec file says the package supports.
- Note that you need to supply the path to the source RPM (which ends in .src.rpm), and not a URL. (If you only have the spec file, use rpmbuild -s SPECFILE to create the new source RPM).
You can learn more about koji via:
koji --help # General help koji --help-commands # list of koji commands koji COMMAND --help # help on command COMMAND
PackageMaintainers/UsingKoji has more information about using Koji.
You also need "curl" installed; if it's not, do:
yum install curl
Get Sponsored
When the package is APPROVED by the reviewer, you must separately obtain member sponsorship in order to check in and build your package. Sponsorship is not automatic and may require that you further participate in other ways in order to demonstrate your understanding of the packaging guidelines. Key to becoming sponsored is to convince an existing sponsor-level member that you understand and follow the project's guidelines and processes.
See PackageMaintainers/HowToGetSponsored for more information on the process of becoming sponsored.
Your sponsor can approve your request and move you from "pending" to "sponsored". You should receive email confirmation of your sponsorship.
Add Package to CVS and Set Owner
Follow CVSAdminProcedure to get a CVS module for your new package and branches for recent releases.
This will be used to set up the proper records in the owners database, which is used for access to build the package, bugzilla population, and other features. This step creates a CVS module for your new package, with empty directories for each requested distribution.
Check out the module
You could check out your module now, but before doing that, consider doing "mkdir ~/cvs ; cd ~/cvs" - that way, all your files are inside that. Also, run ssh-add, so that you won't have to keep typing in your key password.
Now you are ready to checkout your module from CVS:
fedora-cvs <packagename>
Where <packagename>
should be replaced with the name of your package.
You should now have a directory named after your package with a directory for each branch inside of it.
You can use fedora-cvs with many modules at the same time. To checkout from cvs run fedora-cvs {module names seperated by spaces}, for example:
fedora-cvs konversation mysql-gui-tools snort
Import Your Package
Now that you've checked out your (empty) package module with fedora-cvs, cd into the module:
cd MODULE_NAME
Run the common/cvs-import.sh script, to import the contents of the SRPM into CVS:
./common/cvs-import.sh PATH_TO_SRPM
Obviously, replace PATH_TO_SRPM
with the full path (not URL) to your approved SRPM.
This imports into only the devel branch. You will probably also want to do additional imports using the -b parameter, which will import the package into other distribution branches like F-9, e.g.:
./common/cvs-import.sh -b F-9 PATH_TO_SRPM
The cvs-import.sh program will respond with:
Checking out module: 'NAME'
You may see errors like this several times, these can be ignored:
buffer_get_ret: trying to get more bytes 129 than in buffer 34 buffer_get_string_ret: buffer_get failed buffer_get_bignum2_ret: invalid bignum key_from_blob: can't read rsa key key_read: key_from_blob AA.... failed
But among them you should see:
Unpacking source package: NAME....src.rpm...
Along with a list of the source files in the source package, followed by checking and uploading of the files.
Finally, you'll see "If you want to make any changes before committing, please press Ctrl-C. Otherwise press Enter to proceed to commit." Press Enter.
For the changelog, use the same format as the end of the .spec file.
Tag Or Update Your Branches
Branches are F-
# (formerly FC-
#), devel
, etc. So F-9 is the branch for Fedora 9.
Before a branch can be built in the Fedora Package build system, the files in that branch must be tagged in CVS.
The "import" command, described above, automatically tags the files. However, your local directory may not have exactly the right versions of the files, so go into the branch directory (e.g. cd devel/
or cd F-9/
) and run:
cvs up
The "import" script automatically tags the files. However, if you imported your files "by hand" or you're doing a release
bump after a final build failure, instead of using the "import" script, then you need to tag it yourself.
To tag it yourself, when you're happy with the source, go into the branch directory (e.g. cd devel/
) and run:
make tag
You should see it tag the branch with the version and release from the SPEC file. You need to tag all of the branches that you want to build.
Request Builds
For each tagged branch that you'd like to request a build for, go into the branch directory (e.g. cd devel/
) and run:
make build
If everything goes well, it should queue up your branch for building, the package will cleanly build, and you're done!
If it fails to build, the build system will send you an email to report the failure and show you to the logs. Commit any needed changes to cvs, bump the SPEC release number, retag the branch, and request a new build.
Submit Package as Update in Bodhi
The Fedora update system called Bodhi is used for pushing updates, classifying packages etc. Do not submit "devel" (aka rawhide) packages via bodhi.
At one time you could push an update using Bodhi via the command line using:
make update
Now, if you want to use the command line, use the "bodhi" command as described in the Bodhi Guide.
You can also use the Web interface for Bodhi to request enhancement updates for each released Fedora you are bringing a new package to.
The first field asks for the name of the "Package". This field will auto-complete the package name found in the Koji build system, e.g. <package-name>-<version>-<release>.fc9. If completion doesn't work, just enter the package build name yourself.
For new packages, choose "enhancement" as the "type" of update.
Put the "Request" as "testing" if you want to put the package through testing first, see Fedora Quality Assurance . Put "stable" if you want to push the package directly to stable.
Put the bug number of the package's Review Request in the "Bugs" field blank. Bodhi will automatically close it as NEXTRELEASE when it gets pushed to the requested update status.
For new packages, add a copy of the package's description in the "Notes" section, so end users will know what the package is.
Here is the Bodhi Guide and more information on Bodhi .
After you have submitted an upgrade through bodhi, your package is placed in a queue. Periodically, an administrator will check the queue and push all of the packages into the appropriate repositories.
Getting Help
We know that this process can be as clear as mud sometimes, and we're always trying to make it better. If you run into any problems, or have any questions, please ask on the fedora-devel-list mailing list or in #fedora-devel on freenode . See the Communicate page for details.
The Fedora Mentors Project has people willing to help new contributors in their packaging efforts. See the Mentors page for more information.
There is also a helpful CVS FAQ here: PackageMaintainers/UsingCvsFaq
Getting a new package into Fedora Package Collection for existing maintainers
If you already maintain a package in Fedora and want to maintain another, follow the new package process .