From Fedora Project Wiki

(Fix wrong git commands. There is no "git commit -p"! Also, it's "git push" not "git pull" to push the results out to the repository!)
(Add note about git config --global --add push.default tracking)
Line 1: Line 1:
{{admon/important|Contributors only!|This document is for existing Contributors only. If you do not already have a Fedora account or if this is your ''first'' Fedora package, you ''must'' follow the process documented in [[PackageMaintainers/Join]].}}
{{admon/important|Contributors only!|This document is for existing Contributors only. If you do not already have a Fedora account or if this is your ''first'' Fedora package, you ''must'' follow the process documented in [[PackageMaintainers/Join]].}}
{{admon/important | Git config needs| A config problem has been discovered which may make <code>fedpkg push</code> or <code>fedpkg commit -p</code> or even <code>git push</code> not understand your intentions.  As a short term work around, you can run: <code>git config --global --add push.default tracking</code>.  This option tells git that when it gets a push request with no other arguments, see if it's tracking a remote branch.  If it is, push to that remote branch.  This seems like it will usually be safe no matter what git repository you are using.}}


This is a short version of the [[PackageMaintainers/Join]] document, streamlined to show how existing contributors can make new packages.
This is a short version of the [[PackageMaintainers/Join]] document, streamlined to show how existing contributors can make new packages.

Revision as of 01:03, 6 August 2010

Contributors only!
This document is for existing Contributors only. If you do not already have a Fedora account or if this is your first Fedora package, you must follow the process documented in PackageMaintainers/Join.
Git config needs
A config problem has been discovered which may make fedpkg push or fedpkg commit -p or even git push not understand your intentions. As a short term work around, you can run: git config --global --add push.default tracking. This option tells git that when it gets a push request with no other arguments, see if it's tracking a remote branch. If it is, push to that remote branch. This seems like it will usually be safe no matter what git repository you are using.

This is a short version of the PackageMaintainers/Join document, streamlined to show how existing contributors can make new packages.

Step 1: Read the Packaging Guidelines and Package Naming Guidelines . Really. Be comfortable with them.
Step 2: Make a package.

Step 3: Upload your SRPM and SPEC files onto the internet somewhere.

Step 4: Make sure you have a bugzilla account at bugzilla.redhat.com
Step 5: Fill out this form: https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&format=extras-review

  • Make sure you put the name of the package in the Review Summary field, along with a very brief summary of what it is
  • Make sure that you put the URL paths for the SPEC file and the SRPM file in the Review Description
  • Put a description of your package (usually, this can be the same thing as what you put in the spec %description) in Review Description
  • The review process is described in detail here: Package Review Guidelines

Step 6: Watch the bugzilla report for your first package (you created this in step 5). Fix any blockers that the reviewer(s) point out.
Step 7: When the package is approved by the reviewer, request a git module and branches with the Git admin requests .
Step 8: Checkout the git module (details here )

  • Once you have the git module, checkout your module from git. Refer to https://fedoraproject.org/wiki/Using_Fedora_GIT
  • It is probably a good idea to make a "git" toplevel directory, then check-out your files inside of that.
  • If your package is named foobar, this is done with: fedpkg clone foobar

Step 9: Import your srpm

  • Then you can import the approved SRPM into master branch by running fedpkg import libfoo-x.x.x.src.rpm; git commit -m "Initial import (#nnnnnn)." (where nnnnnn is your Bugzilla package review bug number).
  • Obviously, replace nameofmy.src.rpm with the full path to your approved SRPM.
  • You should see it upload the sources, and finish successfully. If you didn't set up ssh-agent it will ask often for your ssh-key passphrase. This is normal.
  • Now run git push to get the final versions in your master branch.

Step 10: You can now import the package to your branches too

  • The quickest way to do this is to use fedpkg switch-branch BRANCH to switch the branch (where BRANCH can be "f13" and so on).
  • Get the sources in. One way is to copy the sources file, .gitignore file, .spec file and any patches from master to each branch. Also check if the Makefile exists and copy it if necessary. After that, git add all copied files. Alternatively, use fedpkg import as above.
  • Once you've put the files in, commit them with: git commit -m "Initial import (#nnnnnn)." and push the results with git push.

Step 11: Request builds

  • For each branch that you'd like to request a build for, switch using fedpkg switch-branch and run: fedpkg 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 buildsystem will send you an email to report the failure and link you to the logs. Commit any needed changes to git, bump the spec release number and request a new build.

Step 12: Close the bugzilla ticket (assuming that the package built successfully)

  • You should close it as NEXTRELEASE.

Step 13: If this package will be built for any version of Fedora that is already released please submit it for inclusion in the 'fedora-updates' repository for those versions of Fedora. See submitting your update to bodhi for more details.
Step 14: Add the package to the comps file(s) if appropriate.

We know that this process can be as clear as mud sometimes, we're always trying to make it better. If you run into any problems, or have any questions, please ask on fedora-devel-list.
https://www.redhat.com/mailman/listinfo/fedora-devel-list/

There is a helpful git FAQ which also includes instructions for making new releases.