This is a detailed documentation for the update functionality of packit. The command creates a new pull request in Fedora (or CentOS Stream) using a selected or latest upstream release. This command is meant to be called from upstream repository.
- Upstream git repository on GitHub/GitLab.
- Upstream release (read, git tag) where version in spec file is equivalent to
the name of the git tag (or
- Packit config file placed in the upstream repository.
- Spec file present in the upstream repository and is correct in a given release.
- Pagure API tokens for Fedora (or CentOS Stream) Dist-git.
- GitHub API token.
- Valid Fedora (or CentOS Stream) Kerberos ticket.
We newly support
propose-downstream also for CentOS Stream, see the configuration specifics
Place a file called
packit.yamlin the root of your upstream repository.
Place a spec file into your upstream project (and make sure that
specfile_pathin the config has a correct value).
- This spec file will be then used to perform the update in Fedora (or CentOS Stream).
- When you create a new upstream release, you should also update the spec file.
- Once your upstream release is out (and the spec file is really up to date), you can use Packit to release it into Fedora (or CentOS Stream).
Create a new upstream release. The spec file needs to be included in the ref for upstream release, because packit checks out the tag for the upstream release before copying files downstream.
Once you have performed the upstream release (and the new archive is up), run
packit propose-downstreamin a working directory of your upstream repository:
$ git clone https://github.com/user-cont/colin.git
$ cd colin
$ packit propose-downstream
using "master" dist-git branch
INFO: Downloading file from URL https://files.pythonhosted.org/packages/source/c/colin/colin-0.3.0.tar.gz
100%[=============================>] 3.18M eta 00:00:00
downloaded archive: /tmp/tmpaanrpgjz/colin-0.3.0.tar.gz
uploading to the lookaside cache
PR created: https://src.fedoraproject.org/rpms/colin/pull-request/4
As you can see, one of the things
propose-downstreamdoes is, it downloads the upstream release tarball and uploads it to the lookaside cache. This is required by the Fedora Packaging Guidelines. Then it copies the files listed in
files_to_sync(which by default includes the spec file) from the upstream repo to downstream and creates the downstream PR.
Usage: packit propose-downstream [OPTIONS] [PATH_OR_URL] [VERSION]
Land a new upstream release in Fedora using upstream packit config.
PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory
VERSION argument is optional, the latest upstream version will be used by
--dist-git-branch TEXT Comma separated list of target branches in dist-git
to release into. (defaults to all branches)
--dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone
the repo in a temporary directory.
--force-new-sources Upload the new sources also when the archive is
already in the lookaside cache.
--pr / --no-pr Create a pull request to downstream repository or
push directly. If not set, defaults to value set in
-f, --force Don't discard changes in the git repo by default,
unless this is set.
-b, --resolve-bug TEXT Bug(s) that are resolved with the update, e.g.
rhbz#123 (multiple can be specified)
--sync-acls Sync ACLs between dist-git repo and the fork, is
considered only with --pr option.
-p, --package TEXT Package to sync downstream, if more than one
available, like in a monorepo configuration. Use it
multiple times to select multiple packages.Defaults
to all the packages listed inside the config.
--local-content Do not checkout release tag. Use the current state
of the repo. This option is set by default for
--upstream-ref TEXT Git ref of the last upstream commit in the current
branch from which packit should generate patches
(this option implies the repository is source-git).
-h, --help Show this message and exit.