1fedpkg(1) rpm-packager fedpkg(1)
2
6 fedpkg - RPM Packaging utility
7
9 fedpkg [ global_options ] command [ command_options ] [ command_argu‐
10 ments ]
11 fedpkg help
12 fedpkg command --help
13
15 fedpkg is a script to interact with the RPM Packaging system.
16 Global Options
18 --config CONFIG, -C CONFIG
19 Specify a config file to use
20 --dry-run Perform a dry run.
21 --release RELEASE Override the discovered release, e.g. f25,
22 which has to match the remote branch name
23 created in package repository. Particularly,
24 use master to build RPMs for rawhide.
25 --dist DIST Deprecated. Use --release instead. You can
26 use --dist for a while for backward-
27 compatibility. It will be disabled in future
28 version.
29 --module-name MODULE_NAME
30 Deprecated. Use combination of --name and
31 --namespace. Override the module name.
32 Otherwise it is discovered from: Git push
33 URL or Git URL (last part of path with .git
34 extension removed) or from name macro in
35 spec file. In that order.
36 --name NAME Override repository name. Use --namespace
37 option to change namespace. If not
38 specified, name is discovered from Git push
39 URL or Git URL (last part of path with .git
40 extension removed) or from Name macro in
41 spec file, in that order.
42 --namespace NAMESPACE
43 The package repository namespace. If
44 omitted, default to rpms if namespace is
45 enabled.
46 --user USER Override the discovered user name
47 --password PASSWORD Password for Koji login
48 --runas RUNAS Run Koji commands as a different user
49 --path PATH Define the directory to work in (defaults to
50 cwd)
51 --verbose, -v Run with verbose debug output
52 --debug, -d Run with debug output
53 -q Run quietly only displaying errors
54 --user-config USER_CONFIG
55 Specify a user config file to use
56
58 fedpkg build [-h] [--arches [ARCHES [ARCHES ...]]] [--md5] [--nowait]
59 [--target TARGET] [--background] [--fail-fast] [--skip-remote-rules-
60 validation] [--skip-nvr-check] [--skip-tag] [--scratch] [--srpm [SRPM]]
61 Request build
62 fedpkg chain-build [-h] [--arches [ARCHES [ARCHES ...]]] [--md5]
64 [--nowait] [--target TARGET] [--background] [--fail-fast] [--skip-
65 remote-rules-validation] package [package ...]
66 Build current package in order with other packages
67 fedpkg ci [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw] [-t] [-F
69 FILE] [-p] [-s] [files [files ...]]
70 Alias for commit
71 fedpkg clean [-h] [--dry-run] [-x]
73 Remove untracked files
74 fedpkg clog [-h] [--raw]
76 Make a clog file containing top changelog entry
77 fedpkg clone [-h] [--branches] [--branch BRANCH] [--anonymous] [--depth
79 DEPTH] repo [clone_target]
80 Clone and checkout a repository
81 fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous] [--depth
83 DEPTH] repo [clone_target]
84 Alias for clone
85 fedpkg commit [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw] [-t]
87 [-F FILE] [-p] [-s] [files [files ...]]
88 Commit changes
89 fedpkg compile [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
91 [--arch ARCH] [--define DEFINE] [--short-circuit] [--nocheck]
92 Local test rpmbuild compile
93 fedpkg container-build [-h] [--target TARGET] [--nowait] [--scratch]
95 [--arches [ARCHES [ARCHES ...]]] [--skip-remote-rules-validation]
96 [--compose-id COMPOSE_ID [COMPOSE_ID ...] | --signing-intent SIGN‐
97 ING_INTENT | --repo-url URL [URL ...]]
98 Build a container
99 fedpkg container-build-setup [-h] (--get-autorebuild | --set-autore‐
101 build {true,false})
102 set options for container-build
103 fedpkg copr-build [-h] [--config CONFIG] [--nowait] project
105 Build package in Copr
106 fedpkg diff [-h] [--cached] [files [files ...]]
108 Show changes between commits, commit and working tree, etc
109 fedpkg flatpak-build [-h] [--target TARGET] [--nowait] [--scratch]
111 [--arches [ARCHES [ARCHES ...]]] [--skip-remote-rules-validation]
112 Build a Flatpak
113 fedpkg gimmespec [-h]
115 Print the spec file name
116 fedpkg gitbuildhash [-h] build
118 Print the git hash used to build the provided n-v-r
119 fedpkg giturl [-h]
121 Print the git url for building
122 fedpkg help [-h]
124 Show usage
125 fedpkg import [-h] [--skip-diffs] [--offline] srpm
127 Import srpm content into a module
128 fedpkg install [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
130 [--arch ARCH] [--define DEFINE] [--short-circuit] [--nocheck]
131 Local test rpmbuild install
132 fedpkg lint [-h] [--info] [--rpmlintconf RPMLINTCONF]
134 Run rpmlint against local spec and build output if present.
135 fedpkg local [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
137 [--arch ARCH] [--define DEFINE] [--md5] [--with BCOND_WITH] [--without
138 BCOND_WITHOUT]
139 Local test rpmbuild binary
140 fedpkg mock-config [-h] [--target TARGET] [--arch ARCH]
142 Generate a mock config
143 fedpkg mockbuild [-h] [--root CONFIG] [--md5] [--no-clean] [--no-
145 cleanup-after] [--no-clean-all] [--with BCOND_WITH] [--without
146 BCOND_WITHOUT] [--shell] [--enablerepo ENABLEREPO] [--disablerepo DIS‐
147 ABLEREPO] [--enable-network]
148 Local test build using mock
149 fedpkg module-build [-h] [--watch] [--buildrequires name:stream]
151 [--requires name:stream] [--optional key=value] [--file [FILE_PATH]]
152 [--srpm SRPMS] [--scratch] [scm_url] [branch]
153 Build a module using MBS
154 fedpkg module-build-cancel [-h] build_id
156 Cancel an MBS module build
157 fedpkg module-build-info [-h] build_id
159 Show information of an MBS module build
160 fedpkg module-build-local [-h] [--file [FILE_PATH]] [--srpm SRPMS]
162 [--stream [STREAM]] [--skip-tests] [--add-local-build N:S:V] [-s N:S]
163 [--offline] [-r PATH]
164 Build a module locally using the mbs-manager command
165 fedpkg module-build-watch [-h] build_id [build_id ...]
167 Watch an MBS build
168 fedpkg module-overview [-h] [--unfinished] [--limit LIMIT]
170 Shows an overview of MBS builds
171 fedpkg module-scratch-build [-h] [--watch] [--buildrequires
173 name:stream] [--requires name:stream] [--optional key=value] [--file
174 [FILE_PATH]] [--srpm SRPMS] [scm_url] [branch]
175 Build a scratch module using MBS
176 fedpkg new [-h]
178 Diff against last tag
179 fedpkg new-sources [-h] files [files ...]
181 Upload source files
182 fedpkg override [-h] {create,extend} ...
184 Manage buildroot overrides
185 fedpkg patch [-h] [--rediff] suffix
187 Create and add a gendiff patch file
188 fedpkg prep [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
190 [--arch ARCH] [--define DEFINE]
191 Local test rpmbuild prep
192 fedpkg pull [-h] [--rebase] [--no-rebase]
194 Pull changes from the remote repository and update the working
195 copy.
196 fedpkg push [-h] [--force]
198 Push changes to remote repository
199 fedpkg releases-info [-h] [-e | -f | -j]
201 Print Fedora or EPEL current active releases
202 fedpkg request-branch [-h] [--repo NAME] [--namespace {rpms,con‐
204 tainer,modules,flatpaks}] [--sl [SL [SL ...]]] [--no-git-branch] [--no-
205 auto-module] [--all-releases] [branch]
206 Request a new dist-git branch
207 fedpkg request-repo [-h] [--namespace {rpms,container,modules,flat‐
209 paks}] [--description DESCRIPTION] [--monitor {no-monitoring,monitor‐
210 ing,monitoring-with-scratch}] [--upstreamurl UPSTREAMURL] [--summary
211 SUMMARY] [--exception] [--no-initial-commit] name [bug]
212 Request a new dist-git repository
213 fedpkg request-tests-repo [-h] name description
215 Request a new tests dist-git repository
216 fedpkg retire [-h] reason
218 Retire a package/module
219 fedpkg scratch-build [-h] [--arches [ARCHES [ARCHES ...]]] [--md5]
221 [--nowait] [--target TARGET] [--background] [--fail-fast] [--skip-
222 remote-rules-validation] [--srpm [SRPM]]
223 Request scratch build
224 fedpkg sources [-h] [--outdir OUTDIR]
226 Download source files
227 fedpkg srpm [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
229 [--arch ARCH] [--define DEFINE] [--md5]
230 Create a source rpm
231 fedpkg switch-branch [-h] [-l] [--fetch] [branch]
233 Work with branches
234 fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [--raw] [-F FILE] [-l] [-d]
236 [tag]
237 Management of git tags
238 fedpkg unused-patches [-h]
240 Print list of patches not referenced by name in the specfile
241 fedpkg update [-h] [--type {bugfix,security,enhancement,newpackage}]
243 [--request {testing,stable}] [--bugs BUGS [BUGS ...]] [--notes NOTES]
244 [--disable-autokarma] [--stable-karma KARMA] [--unstable-karma KARMA]
245 [--not-close-bugs] [--suggest-reboot]
246 Submit last build as update
247 fedpkg upload [-h] files [files ...]
249 Upload source files
250 fedpkg verify-files [-h] [--builddir BUILDDIR] [--buildrootdir BUILD‐
252 ROOTDIR] [--arch ARCH] [--define DEFINE]
253 Locally verify %%files section
254 fedpkg verrel [-h]
256 Print the name-version-release
257
259 fedpkg build
260 usage: fedpkg build [-h] [--arches [ARCHES [ARCHES ...]]] [--md5]
261 [--nowait] [--target TARGET] [--background]
262 [--fail-fast] [--skip-remote-rules-validation]
263 [--skip-nvr-check] [--skip-tag] [--scratch]
264 [--srpm [SRPM]]
265 This command requests a build of the package in the build system. By
267 default it discovers the target to build for based on branch data,
268 and
269 uses the latest commit as the build source.
270 fedpkg is also able to submit multiple builds to Koji at once from
272 stream
273 branch based on a local config, which is inside the repository. The
274 config file
275 is named package.cfg in INI format. For example,
276 [koji]
278 targets = master fedora epel7
279 You only need to put Fedora releases and EPEL in option targets and
281 fedpkg will
282 convert it to proper Koji build target for submitting builds. Beside
283 regular
284 release names, option targets accepts two shortcut names as well,
285 fedora and
286 epel, as you can see in the above example. Name fedora stands for
287 current
288 active Fedora releases, and epel stands for the active EPEL releases,
289 which are
290 el6 and epel7 currently.
291 Note that the config file is a branch specific file. That means you
293 could
294 create package.cfg for each stream branch separately to indicate on
295 which
296 targets to build the package for a particular stream.
297 optional arguments:
299 -h, --help show this help message and exit
300 --arches [ARCHES [ARCHES ...]]
301 Build for specific arches
302 --md5 Use md5 checksums (for older rpm hosts)
303 --nowait Don't wait on build
304 --target TARGET Define build target to build into
305 --background Run the build at a low priority
306 --fail-fast Fail the build immediately if any arch fails
307 --skip-remote-rules-validation
308 Don't check if there's a valid gating.yaml
309 file in the repo, where you can define
310 additional policies for Greenwave gating.
311 --skip-nvr-check Submit build to buildsystem without check if
312 NVR was already built. NVR is constructed
313 locally and may be different from NVR
314 constructed during build on builder.
315 --skip-tag Do not attempt to tag package
316 --scratch Perform a scratch build
317 --srpm [SRPM] Build from an srpm. If no srpm is provided
318 with this option an srpm will be generated
319 from current module content.
320 fedpkg chain-build
323 usage: fedpkg chain-build [-h] [--arches [ARCHES [ARCHES ...]]]
324 [--md5] [--nowait] [--target TARGET]
325 [--background] [--fail-fast]
326 [--skip-remote-rules-validation]
327 package [package ...]
328 Build current package in order with other packages.
330 example: fedpkg chain-build libwidget libgizmo
332 The current package is added to the end of the CHAIN list.
334 Colons (:) can be used in the CHAIN parameter to define groups of
335 packages. Packages in any single group will be built in parallel
336 and all packages in a group must build successfully and populate
337 the repository before the next group will begin building.
338 For example:
340 fedpkg chain-build libwidget libaselib : libgizmo :
342 will cause libwidget and libaselib to be built in parallel, followed
344 by libgizmo and then the current directory package. If no groups are
345 defined, packages will be built sequentially.
346 positional arguments:
348 package List the packages and order you want to
349 build in
350 optional arguments:
352 -h, --help show this help message and exit
353 --arches [ARCHES [ARCHES ...]]
354 Build for specific arches
355 --md5 Use md5 checksums (for older rpm hosts)
356 --nowait Don't wait on build
357 --target TARGET Define build target to build into
358 --background Run the build at a low priority
359 --fail-fast Fail the build immediately if any arch fails
360 --skip-remote-rules-validation
361 Don't check if there's a valid gating.yaml
362 file in the repo, where you can define
363 additional policies for Greenwave gating.
364 fedpkg ci
367 usage: fedpkg ci [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw]
368 [-t] [-F FILE] [-p] [-s]
369 [files [files ...]]
370 Alias for commit.
372 positional arguments:
374 files Optional list of specific files to commit
375 optional arguments:
377 -h, --help show this help message and exit
378 -m MESSAGE, --message MESSAGE
379 Use the given <msg> as the commit message
380 summary
381 --with-changelog Get the last changelog from SPEC as commit
382 message content. This option must be used
383 with -m together.
384 -c, --clog Generate the commit message from the
385 Changelog section
386 --raw Make the clog raw
387 -t, --tag Create a tag for this commit
388 -F FILE, --file FILE Take the commit message from the given file
389 -p, --push Commit and push as one action
390 -s, --signoff Include a signed-off-by
391 fedpkg clean
394 usage: fedpkg clean [-h] [--dry-run] [-x]
395 This command can be used to clean up your working directory. By
397 default it will follow .gitignore rules.
398 optional arguments:
400 -h, --help show this help message and exit
401 --dry-run, -n Perform a dry-run
402 -x Do not follow .gitignore rules
403 fedpkg clog
406 usage: fedpkg clog [-h] [--raw]
407 This will create a file named "clog" that contains the latest rpm
409 changelog entry. The leading "- " text will be stripped.
410 optional arguments:
412 -h, --help show this help message and exit
413 --raw Generate a more "raw" clog without twiddling the
414 contents
415 fedpkg clone
418 usage: fedpkg clone [-h] [--branches] [--branch BRANCH]
419 [--anonymous] [--depth DEPTH]
420 repo [clone_target]
421 This command will clone the named repository from the configured
423 repository base URL. By default it will also checkout the master
424 branch for your working copy.
425 positional arguments:
427 repo Name of the repository to clone
428 clone_target Directory in which to clone the repository
429 optional arguments:
431 -h, --help show this help message and exit
432 --branches, -B Do an old style checkout with subdirs for
433 branches
434 --branch BRANCH, -b BRANCH
435 Check out a specific branch
436 --anonymous, -a Check out a module anonymously
437 --depth DEPTH Create a shallow clone with a history
438 truncated to the specified number of commits
439 fedpkg co
442 usage: fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous]
443 [--depth DEPTH]
444 repo [clone_target]
445 Alias for clone.
447 positional arguments:
449 repo Name of the repository to clone
450 clone_target Directory in which to clone the repository
451 optional arguments:
453 -h, --help show this help message and exit
454 --branches, -B Do an old style checkout with subdirs for
455 branches
456 --branch BRANCH, -b BRANCH
457 Check out a specific branch
458 --anonymous, -a Check out a module anonymously
459 --depth DEPTH Create a shallow clone with a history
460 truncated to the specified number of commits
461 fedpkg commit
464 usage: fedpkg commit [-h] [-m MESSAGE] [--with-changelog] [-c]
465 [--raw] [-t] [-F FILE] [-p] [-s]
466 [files [files ...]]
467 This invokes a git commit. All tracked files with changes will be
469 committed unless a specific file list is provided. $EDITOR will be
470 used to generate a changelog message unless one is given to the
471 command. A push can be done at the same time.
472 positional arguments:
474 files Optional list of specific files to commit
475 optional arguments:
477 -h, --help show this help message and exit
478 -m MESSAGE, --message MESSAGE
479 Use the given <msg> as the commit message
480 summary
481 --with-changelog Get the last changelog from SPEC as commit
482 message content. This option must be used
483 with -m together.
484 -c, --clog Generate the commit message from the
485 Changelog section
486 --raw Make the clog raw
487 -t, --tag Create a tag for this commit
488 -F FILE, --file FILE Take the commit message from the given file
489 -p, --push Commit and push as one action
490 -s, --signoff Include a signed-off-by
491 fedpkg compile
494 usage: fedpkg compile [-h] [--builddir BUILDDIR]
495 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
496 [--define DEFINE] [--short-circuit]
497 [--nocheck]
498 This command calls rpmbuild to compile the source. By default the
500 prep and configure stages will be done as well, unless the short-
501 circuit option is used.
502 optional arguments:
504 -h, --help show this help message and exit
505 --builddir BUILDDIR Define an alternate builddir
506 --buildrootdir BUILDROOTDIR
507 Define an alternate buildrootdir
508 --arch ARCH Prep for a specific arch
509 --define DEFINE Pass custom macros to rpmbuild, may specify
510 multiple times
511 --short-circuit short-circuit compile
512 --nocheck nocheck compile
513 fedpkg container-build
516 usage: fedpkg container-build [-h] [--target TARGET] [--nowait]
517 [--scratch]
518 [--arches [ARCHES [ARCHES ...]]]
519 [--skip-remote-rules-validation]
520 [--compose-id COMPOSE_ID [COMPOSE_ID
521 ...]
522 | --signing-intent SIGNING_INTENT |
523 --repo-url URL [URL ...]]
524 Build a container
526 optional arguments:
528 -h, --help show this help message and exit
529 --target TARGET Override the default target
530 --nowait Don't wait on build
531 --scratch Scratch build
532 --arches [ARCHES [ARCHES ...]]
533 Limit a scratch build to an arch. May have
534 multiple arches.
535 --skip-remote-rules-validation
536 Don't check if there's a valid gating.yaml
537 file in the repo
538 --compose-id COMPOSE_ID [COMPOSE_ID ...]
539 ODCS composes used. Cannot be used with
540 --signing-intent or --repo-url
541 --signing-intent SIGNING_INTENT
542 Signing intent of the ODCS composes. Cannot
543 be used with --compose-id or --repo-url
544 --repo-url URL [URL ...]
545 URLs of yum repo filesCannot be used with
546 --signing-intent or --compose-id
547 fedpkg container-build-setup
550 usage: fedpkg container-build-setup [-h]
551 (--get-autorebuild | --set-
552 autorebuild {true,false})
553 set options for container-build.
555 optional arguments:
557 -h, --help show this help message and exit
558 --get-autorebuild Get autorebuild value
559 --set-autorebuild {true,false}
560 Turn autorebuilds on/off
561 fedpkg copr-build
564 usage: fedpkg copr-build [-h] [--config CONFIG] [--nowait] project
565 Build package in Copr.
567 Note: you need to have set up correct api key. For more information
569 see API KEY section of copr-cli(1) man page.
570 positional arguments:
572 project Name of the project in format USER/PROJECT
573 optional arguments:
575 -h, --help show this help message and exit
576 --config CONFIG Path to an alternative Copr configuration file
577 --nowait Don't wait on build
578 fedpkg diff
581 usage: fedpkg diff [-h] [--cached] [files [files ...]]
582 Use git diff to show changes that have been made to tracked files.
584 By default cached changes (changes that have been git added) will
585 not be shown.
586 positional arguments:
588 files Optionally diff specific files
589 optional arguments:
591 -h, --help show this help message and exit
592 --cached View staged changes
593 fedpkg flatpak-build
596 usage: fedpkg flatpak-build [-h] [--target TARGET] [--nowait]
597 [--scratch]
598 [--arches [ARCHES [ARCHES ...]]]
599 [--skip-remote-rules-validation]
600 Build a Flatpak
602 optional arguments:
604 -h, --help show this help message and exit
605 --target TARGET Override the default target
606 --nowait Don't wait on build
607 --scratch Scratch build
608 --arches [ARCHES [ARCHES ...]]
609 Limit a scratch build to an arch. May have
610 multiple arches.
611 --skip-remote-rules-validation
612 Don't check if there's a valid gating.yaml
613 file in the repo
614 fedpkg gimmespec
617 usage: fedpkg gimmespec [-h]
618 Print the spec file name.
620 optional arguments:
622 -h, --help show this help message and exit
623 fedpkg gitbuildhash
626 usage: fedpkg gitbuildhash [-h] build
627 This will show you the commit hash string used to build the provided
629 build n-v-r
630 positional arguments:
632 build name-version-release of the build to query.
633 optional arguments:
635 -h, --help show this help message and exit
636 fedpkg giturl
639 usage: fedpkg giturl [-h]
640 This will show you which git URL would be used in a build command.
642 It uses the git hashsum of the HEAD of the current branch (which may
643 not be pushed).
644 optional arguments:
646 -h, --help show this help message and exit
647 fedpkg help
650 usage: fedpkg help [-h]
651 Show usage.
653 optional arguments:
655 -h, --help show this help message and exit
656 fedpkg import
659 usage: fedpkg import [-h] [--skip-diffs] [--offline] srpm
660 This will extract sources, patches, and the spec file from an srpm
662 and update the current module accordingly. It will import to the
663 current branch by default.
664 positional arguments:
666 srpm Source rpm to import
667 optional arguments:
669 -h, --help show this help message and exit
670 --skip-diffs Don't show diffs when import srpms
671 --offline Do not upload files into lookaside cache
672 fedpkg install
675 usage: fedpkg install [-h] [--builddir BUILDDIR]
676 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
677 [--define DEFINE] [--short-circuit]
678 [--nocheck]
679 This will call rpmbuild to run the install section. All leading
681 sections will be processed as well, unless the short-circuit option
682 is used.
683 optional arguments:
685 -h, --help show this help message and exit
686 --builddir BUILDDIR Define an alternate builddir
687 --buildrootdir BUILDROOTDIR
688 Define an alternate buildrootdir
689 --arch ARCH Prep for a specific arch
690 --define DEFINE Pass custom macros to rpmbuild, may specify
691 multiple times
692 --short-circuit short-circuit install
693 --nocheck nocheck install
694 fedpkg lint
697 usage: fedpkg lint [-h] [--info] [--rpmlintconf RPMLINTCONF]
698 Rpmlint can be configured using the --rpmlintconf/-r option or by
700 setting a <pkgname>.rpmlintrc file in the working directory
701 optional arguments:
703 -h, --help show this help message and exit
704 --info, -i Display explanations for reported messages
705 --rpmlintconf RPMLINTCONF, -r RPMLINTCONF
706 Use a specific configuration file for
707 rpmlint
708 fedpkg local
711 usage: fedpkg local [-h] [--builddir BUILDDIR]
712 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
713 [--define DEFINE] [--md5] [--with BCOND_WITH]
714 [--without BCOND_WITHOUT]
715 Locally test run of rpmbuild producing binary RPMs. The rpmbuild
717 output will be logged into a file named
718 .build-%{version}-%{release}.log
719 optional arguments:
721 -h, --help show this help message and exit
722 --builddir BUILDDIR Define an alternate builddir
723 --buildrootdir BUILDROOTDIR
724 Define an alternate buildrootdir
725 --arch ARCH Prep for a specific arch
726 --define DEFINE Pass custom macros to rpmbuild, may specify
727 multiple times
728 --md5 Use md5 checksums (for older rpm hosts)
729 --with BCOND_WITH Enable configure option (bcond) for the
730 build
731 --without BCOND_WITHOUT
732 Disable configure option (bcond) for the
733 build
734 fedpkg mock-config
737 usage: fedpkg mock-config [-h] [--target TARGET] [--arch ARCH]
738 This will generate a mock config based on the buildsystem target
740 optional arguments:
742 -h, --help show this help message and exit
743 --target TARGET Override target used for config
744 --arch ARCH Override local arch
745 fedpkg mockbuild
748 usage: fedpkg mockbuild [-h] [--root CONFIG] [--md5] [--no-clean]
749 [--no-cleanup-after] [--no-clean-all]
750 [--with BCOND_WITH]
751 [--without BCOND_WITHOUT] [--shell]
752 [--enablerepo ENABLEREPO]
753 [--disablerepo DISABLEREPO]
754 [--enable-network]
755 This will use the mock utility to build the package for the
757 distribution detected from branch information. This can be
758 overridden using the global --release option. Your user must be in
759 the local "mock" group.
760 optional arguments:
762 -h, --help show this help message and exit
763 --root CONFIG, --mock-config CONFIG
764 Override mock configuration (like mock -r)
765 --md5 Use md5 checksums (for older rpm hosts)
766 --no-clean, -n Do not clean chroot before building package
767 --no-cleanup-after Do not clean chroot after building (if
768 automatic cleanup is enabled
769 --no-clean-all, -N Alias for both --no-clean and --no-cleanup-
770 after
771 --with BCOND_WITH Enable configure option (bcond) for the
772 build
773 --without BCOND_WITHOUT
774 Disable configure option (bcond) for the
775 build
776 --shell Run commands interactively within chroot.
777 Before going into chroot, mockbuild needs to
778 run with --no-cleanup-after in advanced.
779 --enablerepo ENABLEREPO
780 Pass enablerepo option to yum/dnf (may be
781 used more than once)
782 --disablerepo DISABLEREPO
783 Pass disablerepo option to yum/dnf (may be
784 used more than once)
785 --enable-network Enable networking
786 If config file for mock isn't found in the /etc/mock directory, a
788 temporary config directory for mock is created and populated with a
789 config file created with mock-config.
790 fedpkg module-build
793 usage: fedpkg module-build [-h] [--watch]
794 [--buildrequires name:stream]
795 [--requires name:stream]
796 [--optional key=value]
797 [--file [FILE_PATH]] [--srpm SRPMS]
798 [--scratch]
799 [scm_url] [branch]
800 Build a module using MBS
802 positional arguments:
804 scm_url The module's SCM URL. This defaults to the
805 current repo.
806 branch The module's SCM branch. This defaults to
807 the current checked-out branch.
808 optional arguments:
810 -h, --help show this help message and exit
811 --watch, -w Watch the module build
812 --buildrequires name:stream
813 Buildrequires to override in the form of
814 "name:stream"
815 --requires name:stream
816 Requires to override in the form of
817 "name:stream"
818 --optional key=value MBS optional arguments in the form of
819 "key=value"
820 --file [FILE_PATH] The modulemd yaml file for module scratch
821 build.
822 --srpm SRPMS Include one or more srpms for module scratch
823 build.
824 --scratch Perform a scratch build
825 fedpkg module-build-cancel
828 usage: fedpkg module-build-cancel [-h] build_id
829 Cancel an MBS module build
831 positional arguments:
833 build_id The ID of the module build to cancel
834 optional arguments:
836 -h, --help show this help message and exit
837 fedpkg module-build-info
840 usage: fedpkg module-build-info [-h] build_id
841 Show information of an MBS module build
843 positional arguments:
845 build_id The ID of the module build
846 optional arguments:
848 -h, --help show this help message and exit
849 fedpkg module-build-local
852 usage: fedpkg module-build-local [-h] [--file [FILE_PATH]]
853 [--srpm SRPMS] [--stream [STREAM]]
854 [--skip-tests]
855 [--add-local-build N:S:V] [-s N:S]
856 [--offline] [-r PATH]
857 Build a module locally using the mbs-manager command
859 optional arguments:
861 -h, --help show this help message and exit
862 --file [FILE_PATH] The module's modulemd yaml file. If not
863 specified, a yaml file with the same
864 basename as the name of the repository will
865 be used.
866 --srpm SRPMS Include one or more srpms for module build.
867 --stream [STREAM] The module's stream/SCM branch. This
868 defaults to the current checked-out branch.
869 --skip-tests Adds a macro for skipping the check section
870 --add-local-build N:S:V
871 Import previously finished local module
872 builds into MBS in the format of name:stream
873 or name:stream:version
874 -s N:S, --set-default-stream N:S
875 Set the default stream for given module
876 dependency in case there are multiple
877 streams to choose from.
878 --offline Builds module offline without any external
879 infrastructure
880 -r PATH, --repository PATH
881 Full path to .repo file defining the base
882 module repository to use when --offline is
883 used.
884 fedpkg module-build-watch
887 usage: fedpkg module-build-watch [-h] build_id [build_id ...]
888 Watch an MBS build
890 positional arguments:
892 build_id The ID of the module build to watch
893 optional arguments:
895 -h, --help show this help message and exit
896 fedpkg module-overview
899 usage: fedpkg module-overview [-h] [--unfinished] [--limit LIMIT]
900 Shows an overview of MBS builds
902 optional arguments:
904 -h, --help show this help message and exit
905 --unfinished Show unfinished module builds
906 --limit LIMIT The number of most recent module builds to display
907 fedpkg module-scratch-build
910 usage: fedpkg module-scratch-build [-h] [--watch]
911 [--buildrequires name:stream]
912 [--requires name:stream]
913 [--optional key=value]
914 [--file [FILE_PATH]]
915 [--srpm SRPMS]
916 [scm_url] [branch]
917 Build a scratch module using MBS
919 positional arguments:
921 scm_url The module's SCM URL. This defaults to the
922 current repo.
923 branch The module's SCM branch. This defaults to
924 the current checked-out branch.
925 optional arguments:
927 -h, --help show this help message and exit
928 --watch, -w Watch the module build
929 --buildrequires name:stream
930 Buildrequires to override in the form of
931 "name:stream"
932 --requires name:stream
933 Requires to override in the form of
934 "name:stream"
935 --optional key=value MBS optional arguments in the form of
936 "key=value"
937 --file [FILE_PATH] The modulemd yaml file for module scratch
938 build.
939 --srpm SRPMS Include one or more srpms for module scratch
940 build.
941 fedpkg new
944 usage: fedpkg new [-h]
945 This will use git to show a diff of all the changes (even
947 uncommitted changes) since the last git tag was applied.
948 optional arguments:
950 -h, --help show this help message and exit
951 fedpkg new-sources
954 usage: fedpkg new-sources [-h] files [files ...]
955 This will upload new source file(s) to lookaside cache, and all file
957 names listed in sources file will be replaced. .gitignore will be
958 also updated with new uploaded file(s). Please remember to commit
959 them.
960 positional arguments:
962 files
963 optional arguments:
965 -h, --help show this help message and exit
966 fedpkg override
969 usage: fedpkg override [-h] {create,extend} ...
970 Manage buildroot overrides.
972 optional arguments:
974 -h, --help show this help message and exit
975 subcommands:
977 Commands on override
978 {create,extend}
980 create Create buildroot override from build
981 extend Extend buildroot override expiration
982 fedpkg patch
985 usage: fedpkg patch [-h] [--rediff] suffix
986 Create and add a gendiff patch file.
988 positional arguments:
990 suffix Look for files with this suffix to diff
991 optional arguments:
993 -h, --help show this help message and exit
994 --rediff Recreate gendiff file retaining comments Saves old
995 patch file with a suffix of ~
996 Patch file will be named: package-version-suffix.patch and the file
998 will be added to the repo index
999 fedpkg prep
1002 usage: fedpkg prep [-h] [--builddir BUILDDIR]
1003 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
1004 [--define DEFINE]
1005 Use rpmbuild to "prep" the sources (unpack the source archive(s) and
1007 apply any patches.)
1008 optional arguments:
1010 -h, --help show this help message and exit
1011 --builddir BUILDDIR Define an alternate builddir
1012 --buildrootdir BUILDROOTDIR
1013 Define an alternate buildrootdir
1014 --arch ARCH Prep for a specific arch
1015 --define DEFINE Pass custom macros to rpmbuild, may specify
1016 multiple times
1017 fedpkg pull
1020 usage: fedpkg pull [-h] [--rebase] [--no-rebase]
1021 This command uses git to fetch remote changes and apply them to the
1023 current working copy. A rebase option is available which can be used
1024 to avoid merges.
1025 optional arguments:
1027 -h, --help show this help message and exit
1028 --rebase Rebase the locally committed changes on top of the
1029 remote changes after fetching. This can avoid a merge
1030 commit, but does rewrite local history.
1031 --no-rebase Do not rebase, overriding .git settings to the
1032 contrary
1033 See git pull --help for more details
1035 fedpkg push
1038 usage: fedpkg push [-h] [--force]
1039 Push changes to remote repository.
1041 optional arguments:
1043 -h, --help show this help message and exit
1044 --force, -f Force push
1045 fedpkg releases-info
1048 usage: fedpkg releases-info [-h] [-e | -f | -j]
1049 Print Fedora or EPEL current active releases
1051 optional arguments:
1053 -h, --help show this help message and exit
1054 -e, --epel Only show EPEL releases.
1055 -f, --fedora Only show Fedora active releases.
1056 -j, --join Show all releases in one line separated by a space.
1057 fedpkg request-branch
1060 usage: fedpkg request-branch [-h] [--repo NAME]
1061 [--namespace {rpms,container,mod‐
1062 ules,flatpaks}]
1063 [--sl [SL [SL ...]]] [--no-git-branch]
1064 [--no-auto-module] [--all-releases]
1065 [branch]
1066 Request a new dist-git branch
1068 Please refer to the request-repo command to see what has to be done
1070 before
1071 requesting a dist-git branch.
1072 Branch name could be one of current active Fedora and EPEL releases.
1074 Use
1075 command ``fedpkg releases-info`` to get release names that can be
1076 used to request
1077 a branch.
1078 Below are various examples of requesting a dist-git branch.
1080 Request a branch inside a cloned package repository:
1082 fedpkg request-branch f27
1084 Request a branch outside package repository, which could apply to
1086 cases of
1087 requested repository has not been approved and created, or just not
1088 change
1089 directory to package repository:
1090 fedpkg request-branch --repo foo f27
1092 positional arguments:
1094 branch The branch to request.
1095 optional arguments:
1097 -h, --help show this help message and exit
1098 --repo NAME Repository name the new branch is requested
1099 for.
1100 --namespace {rpms,container,modules,flatpaks}
1101 Repository name the new branch is requested
1102 for.
1103 --sl [SL [SL ...]] The service levels (SLs) tied to the branch.
1104 This must be in the format of
1105 "sl_name:2020-12-01". This is only for non-
1106 release branches. You may provide more than
1107 one by separating each SL with a space.
1108 --no-git-branch Don't create the branch in git but still
1109 create it in PDC
1110 --no-auto-module If requesting an rpm arbitrary branch, do
1111 not also request a new matching module. See
1112 https://pagure.io/fedrepo_req/issue/129
1113 --all-releases Make a new branch request for every active
1114 Fedora release
1115 fedpkg request-repo
1118 usage: fedpkg request-repo [-h]
1119 [--namespace {rpms,container,modules,flat‐
1120 paks}]
1121 [--description DESCRIPTION]
1122 [--monitor {no-monitoring,monitoring,moni‐
1123 toring-with-scratch}]
1124 [--upstreamurl UPSTREAMURL]
1125 [--summary SUMMARY] [--exception]
1126 [--no-initial-commit]
1127 name [bug]
1128 Request a new dist-git repository
1130 Before requesting a new dist-git repository for a new package, you
1132 need to
1133 generate a pagure.io API token at https://pagure.io/set‐
1134 tings/token/new, select the
1135 "Create a new ticket" ACL and save it in your local user configura‐
1136 tion located
1137 at ~/.config/rpkg/fedpkg.conf. For example:
1138 [fedpkg.pagure]
1140 token = <api_key_here>
1141 Below is a basic example of the command to request a dist-git reposi‐
1143 tory for
1144 the package foo:
1145 fedpkg request-repo foo 1234
1147 Another example to request a module foo:
1149 fedpkg request-repo --namespace modules foo
1151 positional arguments:
1153 name Repository name to request.
1154 bug Bugzilla bug ID of the package review
1155 request. Not required for requesting a
1156 module repository
1157 optional arguments:
1159 -h, --help show this help message and exit
1160 --namespace {rpms,container,modules,flatpaks}
1161 Namespace of repository. If omitted, default
1162 to rpms.
1163 --description DESCRIPTION, -d DESCRIPTION
1164 The repo's description in dist-git
1165 --monitor {no-monitoring,monitoring,monitoring-with-scratch}, -m
1166 {no-monitoring,monitoring,monitoring-with-scratch}
1167 The Anitya monitoring type for the repo
1168 --upstreamurl UPSTREAMURL, -u UPSTREAMURL
1169 The upstream URL of the project
1170 --summary SUMMARY, -s SUMMARY
1171 Override the package's summary from the
1172 Bugzilla bug
1173 --exception The package is an exception to the regular
1174 package review process (specifically, it
1175 does not require a Bugzilla bug)
1176 --no-initial-commit Do not include an initial commit in the
1177 repository.
1178 fedpkg request-tests-repo
1181 usage: fedpkg request-tests-repo [-h] name description
1182 Request a new dist-git repository in tests shared namespace
1184 https://src.fedoraproject.org/projects/tests/*
1186 For more information about tests shared namespace see
1188 https://fedoraproject.org/wiki/CI/Share_Test_Code
1190 Please refer to the request-repo command to see what has to be done
1192 before
1193 requesting a repository in the tests namespace.
1194 Below is a basic example of the command to request a dist-git reposi‐
1196 tory for
1197 the space tests/foo:
1198 fedpkg request-tests-repo foo "Description of the repository"
1200 Note that the space name needs to reflect the intent of the tests and
1202 will
1203 undergo a manual review.
1204 positional arguments:
1206 name Repository name to request.
1207 description Description of the tests repository
1208 optional arguments:
1210 -h, --help show this help message and exit
1211 fedpkg retire
1214 usage: fedpkg retire [-h] reason
1215 This command will remove all files from the repo, leave a
1217 dead.package file for rpms or dead.module file for modules, and push
1218 the changes.
1219 positional arguments:
1221 reason Reason for retiring the package/module
1222 optional arguments:
1224 -h, --help show this help message and exit
1225 fedpkg scratch-build
1228 usage: fedpkg scratch-build [-h] [--arches [ARCHES [ARCHES ...]]]
1229 [--md5] [--nowait] [--target TARGET]
1230 [--background] [--fail-fast]
1231 [--skip-remote-rules-validation]
1232 [--srpm [SRPM]]
1233 This command will request a scratch build of the package. Without
1235 providing an srpm, it will attempt to build the latest commit, which
1236 must have been pushed. By default all appropriate arches will be
1237 built.
1238 optional arguments:
1240 -h, --help show this help message and exit
1241 --arches [ARCHES [ARCHES ...]]
1242 Build for specific arches
1243 --md5 Use md5 checksums (for older rpm hosts)
1244 --nowait Don't wait on build
1245 --target TARGET Define build target to build into
1246 --background Run the build at a low priority
1247 --fail-fast Fail the build immediately if any arch fails
1248 --skip-remote-rules-validation
1249 Don't check if there's a valid gating.yaml
1250 file in the repo, where you can define
1251 additional policies for Greenwave gating.
1252 --srpm [SRPM] Build from an srpm. If no srpm is provided
1253 with this option an srpm will be generated
1254 from the current module content.
1255 fedpkg sources
1258 usage: fedpkg sources [-h] [--outdir OUTDIR]
1259 Download source files
1261 optional arguments:
1263 -h, --help show this help message and exit
1264 --outdir OUTDIR Directory to download files into (defaults to
1265 pwd)
1266 fedpkg srpm
1269 usage: fedpkg srpm [-h] [--builddir BUILDDIR]
1270 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
1271 [--define DEFINE] [--md5]
1272 Create a source rpm
1274 optional arguments:
1276 -h, --help show this help message and exit
1277 --builddir BUILDDIR Define an alternate builddir
1278 --buildrootdir BUILDROOTDIR
1279 Define an alternate buildrootdir
1280 --arch ARCH Prep for a specific arch
1281 --define DEFINE Pass custom macros to rpmbuild, may specify
1282 multiple times
1283 --md5 Use md5 checksums (for older rpm hosts)
1284 fedpkg switch-branch
1287 usage: fedpkg switch-branch [-h] [-l] [--fetch] [branch]
1288 This command can switch to a local git branch. If provided with a
1290 remote branch name that does not have a local match it will create
1291 one. It can also be used to list the existing local and remote
1292 branches.
1293 positional arguments:
1295 branch Branch name to switch to
1296 optional arguments:
1298 -h, --help show this help message and exit
1299 -l, --list List both remote-tracking branches and local branches
1300 --fetch Fetch new data from remote before switch
1301 fedpkg tag
1304 usage: fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [--raw] [-F FILE] [-l]
1305 [-d]
1306 [tag]
1307 This command uses git to create, list, or delete tags.
1309 positional arguments:
1311 tag Name of the tag
1312 optional arguments:
1314 -h, --help show this help message and exit
1315 -f, --force Force the creation of the tag
1316 -m MESSAGE, --message MESSAGE
1317 Use the given <msg> as the tag message
1318 -c, --clog Generate the tag message from the spec
1319 changelog section
1320 --raw Make the clog raw
1321 -F FILE, --file FILE Take the tag message from the given file
1322 -l, --list List all tags with a given pattern, or all
1323 if not pattern is given
1324 -d, --delete Delete a tag
1325 fedpkg unused-patches
1328 usage: fedpkg unused-patches [-h]
1329 Print list of patches not referenced by name in the specfile.
1331 optional arguments:
1333 -h, --help show this help message and exit
1334 fedpkg update
1337 usage: fedpkg update [-h]
1338 [--type {bugfix,security,enhancement,newpack‐
1339 age}]
1340 [--request {testing,stable}]
1341 [--bugs BUGS [BUGS ...]] [--notes NOTES]
1342 [--disable-autokarma] [--stable-karma KARMA]
1343 [--unstable-karma KARMA] [--not-close-bugs]
1344 [--suggest-reboot]
1345 This will create a bodhi update request for the current package n-v-
1347 r.
1348 There are two ways to specify update details. Without any argument
1350 from command
1351 line, either update type or notes is omitted, a template editor will
1352 be shown
1353 and let you edit the detail information interactively.
1354 Alternatively, you could specify argument from command line to create
1356 an update
1357 directly, for example:
1358 fedpkg update --type bugfix --notes 'Rebuilt' --bugs 1000 1002
1360 When all lines in template editor are commented out or deleted, the
1362 creation
1363 process is aborted. If the template keeps unchanged, fedpkg continues
1364 on creating
1365 update. That gives user a chance to confirm the auto-generated notes
1366 from
1367 change log if option --notes is omitted.
1368 optional arguments:
1370 -h, --help show this help message and exit
1371 --type {bugfix,security,enhancement,newpackage}
1372 Update type. Template editor will be shown
1373 if type is omitted.
1374 --request {testing,stable}
1375 Requested repository.
1376 --bugs BUGS [BUGS ...]
1377 Bug numbers. If omitted, bug numbers will be
1378 extracted from change logs.
1379 --notes NOTES Update description. Multiple lines of notes
1380 could be specified. If omitted, template
1381 editor will be shown.
1382 --disable-autokarma Karma automatism is enabled by default. Use
1383 this option to disable that.
1384 --stable-karma KARMA Stable karma. Default is 3.
1385 --unstable-karma KARMA
1386 Unstable karma. Default is -3.
1387 --not-close-bugs By default, update will be created by
1388 enabling to close bugs automatically. If
1389 this is what you do not want, use this
1390 option to disable the default behavior.
1391 --suggest-reboot Suggest user to reboot after update. Default
1392 is False.
1393 fedpkg upload
1396 usage: fedpkg upload [-h] files [files ...]
1397 This command will upload new source file(s) to lookaside cache.
1399 Source file names are appended to sources file, and .gitignore will
1400 be also updated with new uploaded file(s). Please remember to commit
1401 them.
1402 positional arguments:
1404 files
1405 optional arguments:
1407 -h, --help show this help message and exit
1408 fedpkg verify-files
1411 usage: fedpkg verify-files [-h] [--builddir BUILDDIR]
1412 [--buildrootdir BUILDROOTDIR]
1413 [--arch ARCH] [--define DEFINE]
1414 Locally run 'rpmbuild -bl' to verify the spec file's %files
1416 sections. This requires a successful run of 'fedpkg install' in
1417 advance.
1418 optional arguments:
1420 -h, --help show this help message and exit
1421 --builddir BUILDDIR Define an alternate builddir
1422 --buildrootdir BUILDROOTDIR
1423 Define an alternate buildrootdir
1424 --arch ARCH Prep for a specific arch
1425 --define DEFINE Pass custom macros to rpmbuild, may specify
1426 multiple times
1427 fedpkg verrel
1430 usage: fedpkg verrel [-h]
1431 Print the name-version-release.
1433 optional arguments:
1435 -h, --help show this help message and exit
1436
1439 https://pagure.io/fedpkg/
1440 2019-05-31 fedpkg(1)