wiki:UserDocs
Last modified 3 hours ago Last modified on 09/30/16 10:08:04

User Documentation

This section contains information for users of Copr. You may also be interested in Developer Documentation and downloads.



Tutorial

See screenshots tutorial for interacting with copr.fedoraproject.org

How to enable a repository

Build Source Types

Copr supports several types of build sources.

URL to a SRPM package

This is the only method to submit more builds at once. First, you need to upload your SRPM package(s) on a public server and then provide the URL(s).

Direct Upload of a SRPM package

Upload a SRPM package directly to Copr using the web interface or copr-cli command line client.

Tito

This method builds Using Tito. It does this steps

  1. $ git clone <provided git url> result.git
  2. $ cd result.git
  3. Optionally: $ git checkout <provided branch>
  4. $ tito build --srpm
  5. import the resulting srpm into dist-git

Then it continue as normally.

Mock SCM

This method builds Using Mock SCM plugin. It does

/usr/bin/mock -r epel-7-x86_64 \
    --scm-enable \ 
    --scm-option method=[git,svn] \
    --scm-option package=<name of package>
    --scm-option branch=<name of branch>
    --scm-option write_tar=True \
    --scm-option spec=<spec file>
    --scm-option", "git clone --depth 1" \ # similar command for SVN
    --buildsrpm \
    --resultdir=<some tmp dir>

This will call git-archive and create tar file and SRPM. Resulting SRPM file is then imported into dist-git. Note that it does not bump up neither version nor release. It is your responsibility.

GitHub Webhooks

Webhooks allows you to automatically trigger build.

First you need to go to your Copr project and tab "Packages" and define some package. The methods which makes sense together with webhooks are "mock-scm" and "tito". Check the "Webhook rebuild" option. You may hit "rebuild" and test the build actually works.

Now you can navigate to "Setting" tab and then "Webhooks" There is your webhook url in the form of "https://copr.fedorainfracloud.org/webhooks/github/<ID>/<UUID>/".

Then in your GitHub? project, go to Settings / Webhooks and services. Click on the Add webhook button. Fill in the Payload URL field with the url you noted previously. Leave all other fields untouched (i.e. content: application/json; send just push event; no secret). Click the Add webhook button.

And next time you push anything to your git, Copr will automatically rebuild your package.

Bindings

  • For building package from git:

1) Tito (blog post and another about Tito+git annex)

2) dgroc (blog post)

Multilib

In Copr you cannot build multilib packages, i.e. build a i386 package in a x86_64 chroot. If you need to use multilib packages you will need to specify both repos on your x86_64 system. An example of the rhughes/f20-gnome-3-12 project follows:

Install the repo file for this Copr by copying it to /etc/yum.repos.d and run yum update. If you have a multilib system (i.e. are running x86_64 but have i686 packages installed for flash / steam) then you'll need to modify the .repo file to include both i386 and x86_64 sources, e.g.

$ cat rhughes-f20-gnome-3-12.repo
[rhughes-f20-gnome-3-12-i386]
name=Copr repo for f20-gnome-3-12 owned by rhughes (i386)
baseurl=http://copr-be.cloud.fedoraproject.org/results/rhughes/f20-gnome-3-12/fedora-$releasever-i386/
skip_if_unavailable=True
gpgcheck=0
cost=900
enabled=1

[rhughes-f20-gnome-3-12-x86_64]
name=Copr repo for f20-gnome-3-12 owned by rhughes (x86_64)
baseurl=http://copr-be.cloud.fedoraproject.org/results/rhughes/f20-gnome-3-12/fedora-$releasever-x86_64/
skip_if_unavailable=True
gpgcheck=0
cost=800
enabled=1

Status Badges

Do you want to add such badge: https://copr.fedorainfracloud.org/coprs/g/mock/mock/package/mock/status_image/last_build.png to your page? E.g. to GitHub README.md? You can use those urls:

And this badge will reflect current status of your package.

FAQ

What is the purpose of Copr?

Copr is a build system available for everybody. You provide the src.rpm and Copr provides a yum repository. Copr can be used for upstream builds, for continuous integration, or to provide a yum repository for users of your project, if your project is not yet included in the standard Fedora repositories.

You will need a FAS account in order to get started.

What I can build in Copr?

You agree not to use Copr to upload software code or other material ("Material") that:

  1. you do not have the right to upload or use, such as Material that infringes the rights of any third party under intellectual property or other applicable laws;
  1. is governed in whole or in part by a license not contained in the list of acceptable licenses for Fedora, currently located at https://fedoraproject.org/wiki/Licensing, as that list may be revised from time to time by the Fedora Project Board;
  1. is categorized as a "Forbidden Item" at https://fedoraproject.org/wiki/Forbidden_items, as that page may be revised from time to time by the Fedora Project Board;
  1. is designed to interfere with, disable, overburden, damage, impair or disrupt Copr or Fedora Project infrastructure;
  1. violates any rules or guidelines of the Fedora Project; or
  1. violates any applicable laws and regulations.

It is your responsibility to check licenses and to be sure you can make the resulting yum repo public.

If you think that some repo may be violating a license, you can raise a legal flag - there is a dedicated text area in each project to do so. This will send a notification to the admins and we will act accordingly.

It would be nice if you stated the license of your packages in the Description or Install instructions.

How can I enable a Copr repository?

See HowToEnableRepo

How can I package software as RPM?

There are several tutorials:

Can I build for different versions of Fedora?

Yes. Just hit the "Edit" tab in your project and select several chroots, e.g. "fedora-19-x86_64" and "fedora-18-x86_64". After doing so, when you submit the src.rpm, your package will be built for both of those selected versions of Fedora.

You can build for EPEL as well.

Can I have more yum repositories?

Yes. Each user can have more than one project and each project has one yum repository - to be more precise one repository per chroot.

Can I submit multiple builds at once?

Yes. Just separate them by a space or a new line, but keep in mind that we do not guarantee build order.

What happens when I try to build a package with the same version number?

Your new package will be skipped and marked as built successfully. That is mainly because we are saving the user's time and the server's build power by only building packages with a new version number. This enables the user to submit the same build query as usual, while only changing some of their packages. If you need to have your changes built, please provide a package with a bumped version number.

Can I depend on other packages, which are not in Fedora/EPEL?

Yes, they just need to be available in some yum repository. It can either be another Copr repo or a third-party yum repo (e.g jpackage). Click on "Edit" in your project and add the appropriate repositories into the "Repos" field. Packages from your project are available to be used at build time as well, but only for the project you are currently building and not from your other projects.

Can I give access to my repo to my team mate?

Yes. If somebody wants to build into your project and you want give them access, just point them to your Copr project page. They should then click on the "Permission" tab, and request the permissions they want. "Builder" can only submit builds and "Admin" can approve permissions requests. You will then have to navigate to the same "Permission" tab and either approve or reject the request.

Do you have a command-line client?

Yes. Just do dnf install copr-cli and learn more by man copr-cli.

Do you have an API?

Yes. See the link in the footer of every Copr page or jump directly to the API page.

How long do you keep the builds?

We keep the last successful build from each package indefinitely. All other builds (old packages, failed builds) are deleted after 14 days.

How is Copr pronounced?

In American English Copr is pronounced /ˈkɑ.pɚ/ like the metallic element spelled "copper".

Why another buildsystem?

We didn't start off to create another buildsystem. We originally just wanted to make building third party rpm repositories easier, but after talking to the koji developers and the developers who are building packages for CentOS we realized that there was a need for a maintainable, pluggable, and lightweight build system.

Did you consider OBS?

Yes, we did. See Copr and integration with Koji and Copr Implemented using OBS And the mailing list discussion, as well as the conclusion.

Can I get notifications from Copr builds?

Yes, you can. Enable email/irc/android notifications at Fedora notifications service.

See this example on how to process fedmsg notifications.

What does Copr mean?

Cool Other Package Repositories

How can I tell yum to prefer Copr packages

Building a package with the same version-release number in Copr as the package distributed in the official Fedora repos is discouraged. You should instead bump the release number. Should you build with the same version-release number, you can tell yum to prefer the Copr packages over the distribution provided packages by adding cost=900 to the .repo file.

Can Copr build directly from git?

No. But there are some tools which can create a src.rpm from a git repository and send it to Copr:

1) Tito (blog post)

2) dgroc (blog post)

How do I get notifications about finished builds?

See this blog post.

Why doesn't Copr download my updated package?

Sometimes people report that even though they have updated the src.rpm file and submitted the new build, Copr is still using the old src.rpm. This is typically caused when changes are made to the src.rpm file, but the release number was not bumped up accordingly. As a consequence the resulting files have the same URL, so your browser does not bother to fetch new log files and continues to show those files in its cache. Therefore you are still seeing old content from the previous task.

You should press Ctrl+Shift+R to invalidate your cache and reload page

How can I create new group?

Groups membership is handled by FAS. It can add/remove members to existing group. However it cannot create new group. You can create new group by creating new fedora-infra ticket. Here is one existing ticket, which you can use as example.

Note that you have to log out and then log in again to Copr so Copr can read your new settings.

I see some strange error about /devel/repodata/ in logs.

This is intended. In fact in next release there will be something like "Please ignore the error above".

This is part of feature where you can check in your settings "Create repositories manually". This is intended for big projects like Gnome or KDE, which consist of hundreds of packages. And you want to release them all at the same time. But on the other hand it take days to build them. And of course during the buildtime you need to enable that repository, while at the same time have it disabled/frozen for users.

So if you check "Create repositories manually", we do not run createrepo_c in normal directory, but in ./devel/ directory. This is directory is always passed to mock with

skip_if_unavailable=1

So if Copr have it, then it is used, otherwise ignored. But if it is missing DNF/YUM print the warning above even if it is ignored. Currently there is no way to tell DNF/YUM to not print this warning.

I have a problem and I need to talk to a human

We do not provide support per se, but try your luck here: https://fedorahosted.org/copr/wiki#Communications