1fedpkg(1) rpm-packager fedpkg(1)
2
3
4
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
17 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 rawhide/main branch to build RPMs for
25 rawhide.
26 --name NAME Override repository name. Use --namespace
27 option to change namespace. If not
28 specified, name is discovered from Git push
29 URL or Git URL (last part of path with .git
30 extension removed) or from Name macro in
31 spec file, in that order.
32 --namespace NAMESPACE
33 The package repository namespace. If
34 omitted, default to rpms if namespace is
35 enabled.
36 --user USER Override the discovered user name
37 --password PASSWORD Password for Koji login
38 --runas RUNAS Run Koji commands as a different user
39 --path PATH Define the directory to work in (defaults to
40 cwd)
41 --verbose, -v Run with verbose debug output
42 --debug, -d Run with debug output
43 -q Run quietly only displaying errors
44 --user-config USER_CONFIG
45 Specify a user config file to use
46
48 fedpkg build [-h] [--arches [ARCHES ...]] [--md5] [--nowait] [--target
49 TARGET] [--background] [--fail-fast] [--skip-remote-rules-validation]
50 [--skip-nvr-check] [--custom-user-metadata CUSTOM_USER_METADATA]
51 [--skip-tag] [--scratch] [--srpm [SRPM]] [--srpm-mock]
52 Request build
53
54 fedpkg chain-build [-h] [--arches [ARCHES ...]] [--md5] [--nowait]
55 [--target TARGET] [--background] [--fail-fast] [--skip-remote-rules-
56 validation] [--skip-nvr-check] [--custom-user-metadata CUS‐
57 TOM_USER_METADATA] package [package ...]
58 Build current package in order with other packages
59
60 fedpkg ci [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw] [-t] [-F
61 FILE] [-p] [-s] [files ...]
62 Alias for commit
63
64 fedpkg clean [-h] [--dry-run] [-x]
65 Remove untracked files
66
67 fedpkg clog [-h] [--raw]
68 Make a clog file containing top changelog entry
69
70 fedpkg clone [-h] [--branches] [--branch BRANCH] [--anonymous] [--depth
71 DEPTH] repo [clone_target] ...
72 Clone and checkout a repository
73
74 fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous] [--depth
75 DEPTH] repo [clone_target] ...
76 Alias for clone
77
78 fedpkg commit [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw] [-t]
79 [-F FILE] [-p] [-s] [files ...]
80 Commit changes
81
82 fedpkg compile [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
83 [--arch ARCH] [--define DEFINE] [--short-circuit] [--nocheck] ...
84 Local test rpmbuild compile
85
86 fedpkg container-build [-h] [--target TARGET] [--nowait] [--background]
87 [--build-release BUILD_RELEASE] [--isolated] [--koji-parent-build
88 KOJI_PARENT_BUILD] [--scratch] [--arches [ARCHES ...]] [--repo-url URL
89 [URL ...]] [--signing-intent SIGNING_INTENT] [--skip-remote-rules-vali‐
90 dation] [--skip-build] [--compose-id COMPOSE_ID [COMPOSE_ID ...]]
91 [--replace-dependency PKG_MANAGER:NAME:VERSION[:NEW_NAME] [PKG_MAN‐
92 AGER:NAME:VERSION[:NEW_NAME] ...]]
93 Build a container
94
95 fedpkg container-build-setup [-h] (--get-autorebuild | --set-autore‐
96 build {true,false})
97 set options for container-build
98
99 fedpkg copr-build [-h] [--config CONFIG] [--nowait] project
100 Build package in Copr
101
102 fedpkg diff [-h] [--cached] [files ...]
103 Show changes between commits, commit and working tree, etc
104
105 fedpkg flatpak-build [-h] [--target TARGET] [--nowait] [--background]
106 [--build-release BUILD_RELEASE] [--isolated] [--koji-parent-build
107 KOJI_PARENT_BUILD] [--scratch] [--arches [ARCHES ...]] [--repo-url URL
108 [URL ...]] [--signing-intent SIGNING_INTENT] [--skip-remote-rules-vali‐
109 dation] [--skip-build]
110 Build a Flatpak
111
112 fedpkg fork [-h]
113 Create a new fork of the current repository
114
115 fedpkg gimmespec [-h]
116 Print the spec file name
117
118 fedpkg gitbuildhash [-h] build
119 Print the git hash used to build the provided n-v-r
120
121 fedpkg giturl [-h]
122 Print the git url for building
123
124 fedpkg help [-h]
125 Show usage
126
127 fedpkg import [-h] [--skip-diffs] [--offline] srpm
128 Import srpm content into a module
129
130 fedpkg install [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
131 [--arch ARCH] [--define DEFINE] [--short-circuit] [--nocheck] ...
132 Local test rpmbuild install
133
134 fedpkg lint [-h] [--info] [--rpmlintconf RPMLINTCONF]
135 Run rpmlint against local spec and build output if present.
136
137 fedpkg list-side-tags [-h] [--mine | --user TAG_OWNER | --base-tag
138 BASE_TAG]
139 List existing side-tags
140
141 fedpkg local [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
142 [--arch ARCH] [--define DEFINE] [--md5] [--with BCOND_WITH] [--without
143 BCOND_WITHOUT] ...
144 Local test rpmbuild binary
145
146 fedpkg mock-config [-h] [--target TARGET] [--arch ARCH]
147 Generate a mock config
148
149 fedpkg mockbuild [-h] [--root CONFIG] [--md5] [--no-clean] [--no-
150 cleanup-after] [--no-clean-all] [--with BCOND_WITH] [--without
151 BCOND_WITHOUT] [--shell] [--enablerepo ENABLEREPO] [--disablerepo DIS‐
152 ABLEREPO] [--enable-network] [--srpm-mock] [--use-koji-mock-config |
153 --use-local-mock-config] ...
154 Local test build using mock
155
156 fedpkg module-build [-h] [--watch] [--buildrequires name:stream] [--re‐
157 quires name:stream] [--optional key=value] [--file [FILE_PATH]] [--srpm
158 SRPMS] [--scratch] [scm_url] [branch]
159 Build a module using MBS
160
161 fedpkg module-build-cancel [-h] build_id
162 Cancel an MBS module build
163
164 fedpkg module-build-info [-h] build_id
165 Show information of an MBS module build
166
167 fedpkg module-build-local [-h] [--file [FILE_PATH]] [--srpm SRPMS]
168 [--stream [STREAM]] [--skip-tests] [--add-local-build N:S:V] [-s N:S]
169 [--offline] [-r PATH]
170 Build a module locally using the mbs-manager command
171
172 fedpkg module-build-watch [-h] build_id [build_id ...]
173 Watch an MBS build
174
175 fedpkg module-overview [-h] [--unfinished] [--limit LIMIT] [--owner
176 FAS_ID | --mine]
177 Shows an overview of MBS builds
178
179 fedpkg module-scratch-build [-h] [--watch] [--buildrequires
180 name:stream] [--requires name:stream] [--optional key=value] [--file
181 [FILE_PATH]] [--srpm SRPMS] [scm_url] [branch]
182 Build a scratch module using MBS
183
184 fedpkg new [-h]
185 Diff against last tag
186
187 fedpkg new-sources [-h] [--offline] files [files ...]
188 Upload source files
189
190 fedpkg override [-h] {create,extend} ...
191 Manage buildroot overrides
192
193 fedpkg patch [-h] [--rediff] suffix
194 Create and add a gendiff patch file
195
196 fedpkg prep [-h] [--builddir BUILDDIR] [--buildrootdir BUILDROOTDIR]
197 [--arch ARCH] [--define DEFINE] ...
198 Local test rpmbuild prep
199
200 fedpkg pull [-h] [--rebase] [--no-rebase]
201 Pull changes from the remote repository and update the working
202 copy.
203
204 fedpkg push [-h] [--force]
205 Push changes to remote repository
206
207 fedpkg releases-info [-h] [-e | -f | -j]
208 Print Fedora or EPEL current active releases
209
210 fedpkg remote [-h] {add} ...
211 Operations with tracked repositories ('remotes'). This is an ex‐
212 perimental interface.
213
214 fedpkg remove-side-tag [-h] TAG
215 Remove a side tag (without merging packages)
216
217 fedpkg request-branch [-h] [--repo NAME] [--namespace {rpms,con‐
218 tainer,modules,flatpaks}] [--sl [SL ...]] [--no-git-branch] [--no-auto-
219 module] [--all-releases] [branch]
220 Request a new dist-git branch
221
222 fedpkg request-repo [-h] [--namespace {rpms,container,modules,flat‐
223 paks}] [--description DESCRIPTION] [--monitor {no-monitoring,monitor‐
224 ing,monitoring-with-scratch}] [--upstreamurl UPSTREAMURL] [--summary
225 SUMMARY] [--exception] [--no-initial-commit] name [bug]
226 Request a new dist-git repository
227
228 fedpkg request-side-tag [-h] [--base-tag BASE_TAG] [--suffix SUFFIX]
229 Create a new side tag
230
231 fedpkg request-tests-repo [-h] [--bug BUG] name description
232 Request a new tests dist-git repository
233
234 fedpkg retire [-h] reason
235 Retire a package/module
236
237 fedpkg scratch-build [-h] [--arches [ARCHES ...]] [--md5] [--nowait]
238 [--target TARGET] [--background] [--fail-fast] [--skip-remote-rules-
239 validation] [--skip-nvr-check] [--custom-user-metadata CUS‐
240 TOM_USER_METADATA] [--srpm [SRPM]] [--srpm-mock]
241 Request scratch build
242
243 fedpkg set-distgit-token [-h] token
244 Updates the fedpkg.distgit API token in ~/.con‐
245 fig/rpkg/fedpkg.conf file.
246
247 Tokens are of length 64 and contain only uppercase
248 and numerical values.
249
250 fedpkg set-pagure-token [-h] token
251 Updates the fedpkg.pagure API token in ~/.con‐
252 fig/rpkg/fedpkg.conf file.
253
254 Tokens are of length 64 and contain only uppercase
255 and numerical values.
256
257 fedpkg sources [-h] [--outdir OUTDIR]
258 Download source files
259
260 Create a source rpm
261 Create a source rpm
262
263 fedpkg switch-branch [-h] [-l] [--fetch] [branch]
264 Work with branches
265
266 fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [--raw] [-F FILE] [-l] [-d]
267 [tag]
268 Management of git tags
269
270 fedpkg unused-patches [-h]
271 Print list of patches not referenced by name in the specfile
272
273 fedpkg update [-h] [--type {bugfix,security,enhancement,newpackage}]
274 [--request {testing,stable}] [--bugs BUGS [BUGS ...]] [--notes NOTES]
275 [--disable-autokarma] [--stable-karma KARMA] [--unstable-karma KARMA]
276 [--not-close-bugs] [--no-require-bugs] [--no-require-testcases] [--sug‐
277 gest-reboot | --suggest-logout]
278 Submit last build as update
279
280 fedpkg upload [-h] [--offline] files [files ...]
281 Upload source files
282
283 fedpkg verify-files [-h] [--builddir BUILDDIR] [--buildrootdir BUILD‐
284 ROOTDIR] [--arch ARCH] [--define DEFINE] ...
285 Locally verify %%files section
286
287 fedpkg verrel [-h]
288 Print the name-version-release.
289
291 fedpkg build
292 usage: fedpkg build [-h] [--arches [ARCHES ...]] [--md5] [--nowait]
293 [--target TARGET] [--background] [--fail-fast]
294 [--skip-remote-rules-validation]
295 [--skip-nvr-check]
296 [--custom-user-metadata CUSTOM_USER_METADATA]
297 [--skip-tag] [--scratch] [--srpm [SRPM]]
298 [--srpm-mock]
299
300 This command requests a build of the package in the build
301 system. By
302 default it discovers the target to build for based on branch data,
303 and
304 uses the latest commit as the build source.
305
306 fedpkg is also able to submit multiple builds to Koji at
307 once from stream
308 branch based on a local config, which is inside the
309 repository. The config file
310 is named package.cfg in INI format. For example,
311
312 [koji]
313 targets = rawhide fedora epel7
314
315 You only need to put Fedora releases and EPEL in option
316 targets and fedpkg will
317 convert it to proper Koji build target for submitting
318 builds. Beside regular
319 release names, option targets accepts two shortcut names
320 as well, fedora and
321 epel, as you can see in the above example. Name fedora
322 stands for current
323 active Fedora releases, and epel stands for the active
324 EPEL releases, which are
325 el6 and epel7 currently.
326
327 Note that the config file is a branch specific file. That
328 means you could
329 create package.cfg for each stream branch separately to
330 indicate on which
331 targets to build the package for a particular stream.
332
333 options:
334 -h, --help show this help message and exit
335 --arches [ARCHES ...]
336 Build for specific arches
337 --md5 Use md5 checksums (for older rpm hosts)
338 --nowait Don't wait on build
339 --target TARGET Define build target to build into
340 --background Run the build at a low priority
341 --fail-fast Fail the build immediately if any arch fails
342 --skip-remote-rules-validation
343 Don't check if there's a valid gating.yaml
344 file in the repo, where you can define
345 additional policies for Greenwave gating.
346 --skip-nvr-check Submit build to buildsystem without check if
347 NVR was already built. NVR is constructed
348 locally and may be different from NVR
349 constructed during build on builder.
350 --custom-user-metadata CUSTOM_USER_METADATA
351 Provide a JSON string of custom metadata to
352 be deserialized and stored under the build's
353 extra.custom_user_metadata field
354 --skip-tag Do not attempt to tag package
355 --scratch Perform a scratch build
356 --srpm [SRPM] Build from an srpm. If no srpm is provided
357 with this option an srpm will be generated
358 from current module content.
359 --srpm-mock Build from an srpm. Source rpm will be
360 generated in 'mock' instead of 'rpmbuild'.
361
362
363 fedpkg chain-build
364 usage: fedpkg chain-build [-h] [--arches [ARCHES ...]] [--md5]
365 [--nowait] [--target TARGET]
366 [--background] [--fail-fast]
367 [--skip-remote-rules-validation]
368 [--skip-nvr-check]
369 [--custom-user-metadata CUSTOM_USER_META‐
370 DATA]
371 package [package ...]
372
373 Build current package in order with other packages.
374
375 example: fedpkg chain-build libwidget libgizmo
376
377 The current package is added to the end of the CHAIN list.
378 Colons (:) can be used in the CHAIN parameter to define groups of
379 packages. Packages in any single group will be built in parallel
380 and all packages in a group must build successfully and populate
381 the repository before the next group will begin building.
382
383 For example:
384
385 fedpkg chain-build libwidget libaselib : libgizmo :
386
387 will cause libwidget and libaselib to be built in parallel, followed
388 by libgizmo and then the current directory package. If no groups are
389 defined, packages will be built sequentially.
390
391 positional arguments:
392 package List the packages and order you want to
393 build in
394
395 options:
396 -h, --help show this help message and exit
397 --arches [ARCHES ...]
398 Build for specific arches
399 --md5 Use md5 checksums (for older rpm hosts)
400 --nowait Don't wait on build
401 --target TARGET Define build target to build into
402 --background Run the build at a low priority
403 --fail-fast Fail the build immediately if any arch fails
404 --skip-remote-rules-validation
405 Don't check if there's a valid gating.yaml
406 file in the repo, where you can define
407 additional policies for Greenwave gating.
408 --skip-nvr-check Submit build to buildsystem without check if
409 NVR was already built. NVR is constructed
410 locally and may be different from NVR
411 constructed during build on builder.
412 --custom-user-metadata CUSTOM_USER_METADATA
413 Provide a JSON string of custom metadata to
414 be deserialized and stored under the build's
415 extra.custom_user_metadata field
416
417
418 fedpkg ci
419 usage: fedpkg ci [-h] [-m MESSAGE] [--with-changelog] [-c] [--raw]
420 [-t] [-F FILE] [-p] [-s]
421 [files ...]
422
423 Alias for commit.
424
425 positional arguments:
426 files Optional list of specific files to commit
427
428 options:
429 -h, --help show this help message and exit
430 -m MESSAGE, --message MESSAGE
431 Use the given <msg> as the commit message
432 summary
433 --with-changelog Get the last changelog from SPEC as commit
434 message content. This option must be used
435 with -m together.
436 -c, --clog Generate the commit message from the
437 Changelog section
438 --raw Make the clog raw
439 -t, --tag Create a tag for this commit
440 -F FILE, --file FILE Take the commit message from the given file
441 -p, --push Commit and push as one action
442 -s, --signoff Include a signed-off-by
443
444
445 fedpkg clean
446 usage: fedpkg clean [-h] [--dry-run] [-x]
447
448 This command can be used to clean up your working directory. By
449 default it will follow .gitignore rules. Patterns listed in
450 .git/info/exclude won'tbe removed either.
451
452 options:
453 -h, --help show this help message and exit
454 --dry-run, -n Perform a dry-run
455 -x Do not follow .gitignore and .git/info/exclude
456 rules
457
458
459 fedpkg clog
460 usage: fedpkg clog [-h] [--raw]
461
462 This will create a file named "clog" that contains the latest rpm
463 changelog entry. The leading "- " text will be stripped.
464
465 options:
466 -h, --help show this help message and exit
467 --raw Generate a more "raw" clog without twiddling the
468 contents
469
470
471 fedpkg clone
472 usage: fedpkg clone [-h] [--branches] [--branch BRANCH]
473 [--anonymous] [--depth DEPTH]
474 repo [clone_target] ...
475
476 This command will clone the named repository from the configured
477 repository base URL. By default it will also checkout the master
478 branch for your working copy.
479
480 positional arguments:
481 repo Name of the repository to clone. It should
482 not be a Git URL. Should be 'namespace/repo-
483 name' in case of namespaced dist-git.
484 Otherwise, just 'repo-name'. Namespace
485 examples are 'rpms', 'container', 'modules',
486 'flatpaks'. Default namespace 'rpms' can be
487 ignored.
488 clone_target Directory in which to clone the repository
489 extra_args Custom arguments that are passed to the 'git
490 clone'. Use '--' to separate them from other
491 arguments.
492
493 options:
494 -h, --help show this help message and exit
495 --branches, -B Do an old style checkout with subdirs for
496 branches
497 --branch BRANCH, -b BRANCH
498 Check out a specific branch
499 --anonymous, -a Check out a module anonymously
500 --depth DEPTH Create a shallow clone with a history
501 truncated to the specified number of commits
502
503
504 fedpkg co
505 usage: fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous]
506 [--depth DEPTH]
507 repo [clone_target] ...
508
509 Alias for clone.
510
511 positional arguments:
512 repo Name of the repository to clone. It should
513 not be a Git URL. Should be 'namespace/repo-
514 name' in case of namespaced dist-git.
515 Otherwise, just 'repo-name'. Namespace
516 examples are 'rpms', 'container', 'modules',
517 'flatpaks'. Default namespace 'rpms' can be
518 ignored.
519 clone_target Directory in which to clone the repository
520 extra_args Custom arguments that are passed to the 'git
521 clone'. Use '--' to separate them from other
522 arguments.
523
524 options:
525 -h, --help show this help message and exit
526 --branches, -B Do an old style checkout with subdirs for
527 branches
528 --branch BRANCH, -b BRANCH
529 Check out a specific branch
530 --anonymous, -a Check out a module anonymously
531 --depth DEPTH Create a shallow clone with a history
532 truncated to the specified number of commits
533
534
535 fedpkg commit
536 usage: fedpkg commit [-h] [-m MESSAGE] [--with-changelog] [-c]
537 [--raw] [-t] [-F FILE] [-p] [-s]
538 [files ...]
539
540 This invokes a git commit. All tracked files with changes will be
541 committed unless a specific file list is provided. $EDITOR will be
542 used to generate a changelog message unless one is given to the
543 command. A push can be done at the same time.
544
545 positional arguments:
546 files Optional list of specific files to commit
547
548 options:
549 -h, --help show this help message and exit
550 -m MESSAGE, --message MESSAGE
551 Use the given <msg> as the commit message
552 summary
553 --with-changelog Get the last changelog from SPEC as commit
554 message content. This option must be used
555 with -m together.
556 -c, --clog Generate the commit message from the
557 Changelog section
558 --raw Make the clog raw
559 -t, --tag Create a tag for this commit
560 -F FILE, --file FILE Take the commit message from the given file
561 -p, --push Commit and push as one action
562 -s, --signoff Include a signed-off-by
563
564
565 fedpkg compile
566 usage: fedpkg compile [-h] [--builddir BUILDDIR]
567 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
568 [--define DEFINE] [--short-circuit]
569 [--nocheck]
570 ...
571
572 This command calls rpmbuild to compile the source. By default the
573 prep and configure stages will be done as well, unless the short-
574 circuit option is used.
575
576 positional arguments:
577 extra_args Custom arguments that are passed to the
578 'rpmbuild'. Use '--' to separate them from
579 other arguments.
580
581 options:
582 -h, --help show this help message and exit
583 --builddir BUILDDIR Define an alternate builddir
584 --buildrootdir BUILDROOTDIR
585 Define an alternate buildrootdir
586 --arch ARCH Prep for a specific arch
587 --define DEFINE Pass custom macros to rpmbuild, may specify
588 multiple times
589 --short-circuit short-circuit compile
590 --nocheck nocheck compile
591
592
593 fedpkg container-build
594 usage: fedpkg container-build [-h] [--target TARGET] [--nowait]
595 [--background]
596 [--build-release BUILD_RELEASE]
597 [--isolated]
598 [--koji-parent-build KOJI_PARENT_BUILD]
599 [--scratch] [--arches [ARCHES ...]]
600 [--repo-url URL [URL ...]]
601 [--signing-intent SIGNING_INTENT]
602 [--skip-remote-rules-validation]
603 [--skip-build]
604 [--compose-id COMPOSE_ID [COMPOSE_ID
605 ...]]
606 [--replace-dependency PKG_MAN‐
607 AGER:NAME:VERSION[:NEW_NAME]
608 [PKG_MANAGER:NAME:VERSION[:NEW_NAME]
609 ...]]
610
611 Build a container
612
613 options:
614 -h, --help show this help message and exit
615 --target TARGET Override the default target
616 --nowait Don't wait on build
617 --background Run the build at a lower priority
618 --build-release BUILD_RELEASE
619 Specify a release value for this build's NVR
620 --isolated Do not update floating tags in the registry.
621 You must use the --build-release argument
622 --koji-parent-build KOJI_PARENT_BUILD
623 Specify a Koji NVR for the parent container
624 image. This will override the "FROM" value
625 in your Dockerfile.
626 --scratch Scratch build
627 --arches [ARCHES ...]
628 Limit a scratch or a isolated build to an
629 arch. May have multiple arches.
630 --repo-url URL [URL ...]
631 URLs of yum repo files
632 --signing-intent SIGNING_INTENT
633 Signing intent of the ODCS composes. If
634 specified, this must be one of the signing
635 intent names configured on the OSBS server.
636 If unspecified, the server will use the
637 signing intent of the compose_ids you
638 specify, or the server's
639 default_signing_intent. To view the full
640 list of possible names, see REACTOR_CONFIG
641 in orchestrator.log.
642 --skip-remote-rules-validation
643 Don't check if there's a valid gating.yaml
644 file in the repo
645 --skip-build Don't create build, but just modify settings
646 for autorebuilds
647 --compose-id COMPOSE_ID [COMPOSE_ID ...]
648 Use existing ODCS composes (specify
649 integers). Cannot be used with --signing-
650 intent.
651 --replace-dependency PKG_MANAGER:NAME:VERSION[:NEW_NAME] [PKG_MAN‐
652 AGER:NAME:VERSION[:NEW_NAME] ...]
653 Cachito dependency replacement
654
655
656 fedpkg container-build-setup
657 usage: fedpkg container-build-setup [-h]
658 (--get-autorebuild | --set-au‐
659 torebuild {true,false})
660
661 set options for container-build.
662
663 options:
664 -h, --help show this help message and exit
665 --get-autorebuild Get autorebuild value
666 --set-autorebuild {true,false}
667 Turn autorebuilds on/off
668
669
670 fedpkg copr-build
671 usage: fedpkg copr-build [-h] [--config CONFIG] [--nowait] project
672
673 Build package in Copr.
674
675 Note: you need to have set up correct api key. For more information
676 see API KEY section of copr-cli(1) man page.
677
678 positional arguments:
679 project Name of the project in format USER/PROJECT
680
681 options:
682 -h, --help show this help message and exit
683 --config CONFIG Path to an alternative Copr configuration file
684 --nowait Don't wait on build
685
686
687 fedpkg diff
688 usage: fedpkg diff [-h] [--cached] [files ...]
689
690 Use git diff to show changes that have been made to tracked files.
691 By default cached changes (changes that have been git added) will
692 not be shown.
693
694 positional arguments:
695 files Optionally diff specific files
696
697 options:
698 -h, --help show this help message and exit
699 --cached View staged changes
700
701
702 fedpkg flatpak-build
703 usage: fedpkg flatpak-build [-h] [--target TARGET] [--nowait]
704 [--background]
705 [--build-release BUILD_RELEASE]
706 [--isolated]
707 [--koji-parent-build KOJI_PARENT_BUILD]
708 [--scratch] [--arches [ARCHES ...]]
709 [--repo-url URL [URL ...]]
710 [--signing-intent SIGNING_INTENT]
711 [--skip-remote-rules-validation]
712 [--skip-build]
713
714 Build a Flatpak
715
716 options:
717 -h, --help show this help message and exit
718 --target TARGET Override the default target
719 --nowait Don't wait on build
720 --background Run the build at a lower priority
721 --build-release BUILD_RELEASE
722 Specify a release value for this build's NVR
723 --isolated Do not update floating tags in the registry.
724 You must use the --build-release argument
725 --koji-parent-build KOJI_PARENT_BUILD
726 Specify a Koji NVR for the parent container
727 image. This will override the "FROM" value
728 in your Dockerfile.
729 --scratch Scratch build
730 --arches [ARCHES ...]
731 Limit a scratch or a isolated build to an
732 arch. May have multiple arches.
733 --repo-url URL [URL ...]
734 URLs of yum repo files
735 --signing-intent SIGNING_INTENT
736 Signing intent of the ODCS composes. If
737 specified, this must be one of the signing
738 intent names configured on the OSBS server.
739 If unspecified, the server will use the
740 signing intent of the compose_ids you
741 specify, or the server's
742 default_signing_intent. To view the full
743 list of possible names, see REACTOR_CONFIG
744 in orchestrator.log.
745 --skip-remote-rules-validation
746 Don't check if there's a valid gating.yaml
747 file in the repo
748 --skip-build Don't create build, but just modify settings
749 for autorebuilds
750
751
752 fedpkg fork
753 usage: fedpkg fork [-h]
754
755 Create a new fork of the current repository
756
757 Before the operation, you need to generate a pagure.io API token at:
758 https://src.fedoraproject.org/settings/token/new
759
760 ACL required:
761 "Fork a project"
762
763 Update your token with the following command:
764 fedpkg set-distgit-token <api_key_here>
765
766 Command saves token to fedpkg config file:
767 ~/.config/rpkg/fedpkg.conf
768
769 For example:
770 [fedpkg.distgit]
771 token = <api_key_here>
772
773 Below is a basic example of the command to fork a current repository:
774
775 fedpkg fork
776
777 Operation requires username (FAS_ID). by default, current logged
778 username is taken. It could be overridden by reusing an argument:
779
780 fedpkg --user FAS_ID fork
781
782 options:
783 -h, --help show this help message and exit
784
785
786 fedpkg gimmespec
787 usage: fedpkg gimmespec [-h]
788
789 Print the spec file name.
790
791 options:
792 -h, --help show this help message and exit
793
794
795 fedpkg gitbuildhash
796 usage: fedpkg gitbuildhash [-h] build
797
798 This will show you the commit hash string used to build the provided
799 build n-v-r
800
801 positional arguments:
802 build name-version-release of the build to query.
803
804 options:
805 -h, --help show this help message and exit
806
807
808 fedpkg giturl
809 usage: fedpkg giturl [-h]
810
811 This will show you which git URL would be used in a build command.
812 It uses the git hashsum of the HEAD of the current branch (which may
813 not be pushed).
814
815 options:
816 -h, --help show this help message and exit
817
818
819 fedpkg help
820 usage: fedpkg help [-h]
821
822 Show usage.
823
824 options:
825 -h, --help show this help message and exit
826
827
828 fedpkg import
829 usage: fedpkg import [-h] [--skip-diffs] [--offline] srpm
830
831 This will extract sources, patches, and the spec file from an srpm
832 and update the current module accordingly. It will import to the
833 current branch by default.
834
835 positional arguments:
836 srpm Source rpm to import
837
838 options:
839 -h, --help show this help message and exit
840 --skip-diffs Don't show diffs when import srpms
841 --offline Do not upload files into lookaside cache
842
843
844 fedpkg install
845 usage: fedpkg install [-h] [--builddir BUILDDIR]
846 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
847 [--define DEFINE] [--short-circuit]
848 [--nocheck]
849 ...
850
851 This will call rpmbuild to run the install section. All leading
852 sections will be processed as well, unless the short-circuit option
853 is used.
854
855 positional arguments:
856 extra_args Custom arguments that are passed to the
857 'rpmbuild'. Use '--' to separate them from
858 other arguments.
859
860 options:
861 -h, --help show this help message and exit
862 --builddir BUILDDIR Define an alternate builddir
863 --buildrootdir BUILDROOTDIR
864 Define an alternate buildrootdir
865 --arch ARCH Prep for a specific arch
866 --define DEFINE Pass custom macros to rpmbuild, may specify
867 multiple times
868 --short-circuit short-circuit install
869 --nocheck nocheck install
870
871
872 fedpkg lint
873 usage: fedpkg lint [-h] [--info] [--rpmlintconf RPMLINTCONF]
874
875 Rpmlint can be configured using the --rpmlintconf/-r option or by
876 setting a <pkgname>.rpmlintrc file in the working directory
877
878 options:
879 -h, --help show this help message and exit
880 --info, -i Display explanations for reported messages
881 --rpmlintconf RPMLINTCONF, -r RPMLINTCONF
882 Use a specific configuration file for
883 rpmlint
884
885
886 fedpkg list-side-tags
887 usage: fedpkg list-side-tags [-h]
888 [--mine | --user TAG_OWNER | --base-tag
889 BASE_TAG]
890
891 List existing side-tags.
892
893 options:
894 -h, --help show this help message and exit
895 --mine List only my side tags
896 --user TAG_OWNER List side tags created by this user
897 --base-tag BASE_TAG List only tags based on this base
898
899
900 fedpkg local
901 usage: fedpkg local [-h] [--builddir BUILDDIR]
902 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
903 [--define DEFINE] [--md5] [--with BCOND_WITH]
904 [--without BCOND_WITHOUT]
905 ...
906
907 Locally test run of rpmbuild producing binary RPMs. The rpmbuild
908 output will be logged into a file named
909 .build-%{version}-%{release}.log
910
911 positional arguments:
912 extra_args Custom arguments that are passed to the
913 'rpmbuild'. Use '--' to separate them from
914 other arguments.
915
916 options:
917 -h, --help show this help message and exit
918 --builddir BUILDDIR Define an alternate builddir
919 --buildrootdir BUILDROOTDIR
920 Define an alternate buildrootdir
921 --arch ARCH Prep for a specific arch
922 --define DEFINE Pass custom macros to rpmbuild, may specify
923 multiple times
924 --md5 Use md5 checksums (for older rpm hosts)
925 --with BCOND_WITH Enable configure option (bcond) for the
926 build
927 --without BCOND_WITHOUT
928 Disable configure option (bcond) for the
929 build
930
931
932 fedpkg mock-config
933 usage: fedpkg mock-config [-h] [--target TARGET] [--arch ARCH]
934
935 This will generate a mock config based on the buildsystem target
936
937 options:
938 -h, --help show this help message and exit
939 --target TARGET Override target used for config
940 --arch ARCH Override local arch
941
942
943 fedpkg mockbuild
944 usage: fedpkg mockbuild [-h] [--root CONFIG] [--md5] [--no-clean]
945 [--no-cleanup-after] [--no-clean-all]
946 [--with BCOND_WITH]
947 [--without BCOND_WITHOUT] [--shell]
948 [--enablerepo ENABLEREPO]
949 [--disablerepo DISABLEREPO]
950 [--enable-network] [--srpm-mock]
951 [--use-koji-mock-config | --use-local-mock-
952 config]
953 ...
954
955 This will use the mock utility to build the package for the
956 distribution detected from branch information. This can be
957 overridden using the global --release option. Your user must be in
958 the local "mock" group.
959
960 positional arguments:
961 extra_args Custom arguments that are passed to the
962 'mock'. Use '--' to separate them from other
963 arguments.
964
965 options:
966 -h, --help show this help message and exit
967 --root CONFIG, --mock-config CONFIG
968 Override mock configuration (like mock -r)
969 --md5 Use md5 checksums (for older rpm hosts)
970 --no-clean, -n Do not clean chroot before building package
971 --no-cleanup-after Do not clean chroot after building (if
972 automatic cleanup is enabled
973 --no-clean-all, -N Alias for both --no-clean and --no-cleanup-
974 after
975 --with BCOND_WITH Enable configure option (bcond) for the
976 build
977 --without BCOND_WITHOUT
978 Disable configure option (bcond) for the
979 build
980 --shell Run commands interactively within chroot.
981 Before going into chroot, mockbuild needs to
982 run with --no-cleanup-after in advanced.
983 --enablerepo ENABLEREPO
984 Pass enablerepo option to yum/dnf (may be
985 used more than once)
986 --disablerepo DISABLEREPO
987 Pass disablerepo option to yum/dnf (may be
988 used more than once)
989 --enable-network Enable networking
990 --srpm-mock Generate source rpm with 'mock' and then run
991 'mockbuild' using this source rpm
992 --use-koji-mock-config
993 Download Mock configuration from Kojihub,
994 instead of using the local Mock
995 configuration in mock-core-configs.rpm.
996 --use-local-mock-config
997 Enforce use of local Mock configuration.
998
999 If config file for mock isn't found in the /etc/mock directory, a
1000 temporary config directory for mock is created and populated with a
1001 config file created with mock-config.
1002
1003
1004 fedpkg module-build
1005 usage: fedpkg module-build [-h] [--watch]
1006 [--buildrequires name:stream]
1007 [--requires name:stream]
1008 [--optional key=value]
1009 [--file [FILE_PATH]] [--srpm SRPMS]
1010 [--scratch]
1011 [scm_url] [branch]
1012
1013 Build a module using MBS
1014
1015 positional arguments:
1016 scm_url The module's SCM URL. This defaults to the
1017 current repo.
1018 branch The module's SCM branch. This defaults to
1019 the current checked-out branch.
1020
1021 options:
1022 -h, --help show this help message and exit
1023 --watch, -w Watch the module build
1024 --buildrequires name:stream
1025 Buildrequires to override in the form of
1026 "name:stream"
1027 --requires name:stream
1028 Requires to override in the form of
1029 "name:stream"
1030 --optional key=value MBS optional arguments in the form of
1031 "key=value". For example: 'fedpkg module-
1032 build --optional
1033 "reuse_components_from=<NSVC>"'. More
1034 description including list of available
1035 arguments here: https://pagure.io/fm-
1036 orchestrator/
1037 --file [FILE_PATH] The modulemd yaml file for module scratch
1038 build.
1039 --srpm SRPMS Include one or more srpms for module scratch
1040 build.
1041 --scratch Perform a scratch build
1042
1043
1044 fedpkg module-build-cancel
1045 usage: fedpkg module-build-cancel [-h] build_id
1046
1047 Cancel an MBS module build
1048
1049 positional arguments:
1050 build_id The ID of the module build to cancel
1051
1052 options:
1053 -h, --help show this help message and exit
1054
1055
1056 fedpkg module-build-info
1057 usage: fedpkg module-build-info [-h] build_id
1058
1059 Show information of an MBS module build
1060
1061 positional arguments:
1062 build_id The ID of the module build
1063
1064 options:
1065 -h, --help show this help message and exit
1066
1067
1068 fedpkg module-build-local
1069 usage: fedpkg module-build-local [-h] [--file [FILE_PATH]]
1070 [--srpm SRPMS] [--stream [STREAM]]
1071 [--skip-tests]
1072 [--add-local-build N:S:V] [-s N:S]
1073 [--offline] [-r PATH]
1074
1075 Build a module locally using the mbs-manager command
1076
1077 options:
1078 -h, --help show this help message and exit
1079 --file [FILE_PATH] The module's modulemd yaml file. If not
1080 specified, a yaml file with the same
1081 basename as the name of the repository will
1082 be used.
1083 --srpm SRPMS Include one or more srpms for module build.
1084 --stream [STREAM] The module's stream/SCM branch. This
1085 defaults to the current checked-out branch.
1086 --skip-tests Adds a macro for skipping the check section
1087 --add-local-build N:S:V
1088 Import previously finished local module
1089 builds into MBS in the format of name:stream
1090 or name:stream:version
1091 -s N:S, --set-default-stream N:S
1092 Set the default stream for given module
1093 dependency in case there are multiple
1094 streams to choose from.
1095 --offline Builds module offline without any external
1096 infrastructure
1097 -r PATH, --repository PATH
1098 Full path to .repo file defining the base
1099 module repository to use when --offline is
1100 used.
1101
1102
1103 fedpkg module-build-watch
1104 usage: fedpkg module-build-watch [-h] build_id [build_id ...]
1105
1106 Watch an MBS build
1107
1108 positional arguments:
1109 build_id The ID of the module build to watch
1110
1111 options:
1112 -h, --help show this help message and exit
1113
1114
1115 fedpkg module-overview
1116 usage: fedpkg module-overview [-h] [--unfinished] [--limit LIMIT]
1117 [--owner FAS_ID | --mine]
1118
1119 Shows an overview of MBS builds
1120
1121 options:
1122 -h, --help show this help message and exit
1123 --unfinished Show unfinished module builds
1124 --limit LIMIT The number of most recent module builds to display
1125 --owner FAS_ID List only items of that owner
1126 --mine Use current Kerberos name or username
1127
1128
1129 fedpkg module-scratch-build
1130 usage: fedpkg module-scratch-build [-h] [--watch]
1131 [--buildrequires name:stream]
1132 [--requires name:stream]
1133 [--optional key=value]
1134 [--file [FILE_PATH]]
1135 [--srpm SRPMS]
1136 [scm_url] [branch]
1137
1138 Build a scratch module using MBS
1139
1140 positional arguments:
1141 scm_url The module's SCM URL. This defaults to the
1142 current repo.
1143 branch The module's SCM branch. This defaults to
1144 the current checked-out branch.
1145
1146 options:
1147 -h, --help show this help message and exit
1148 --watch, -w Watch the module build
1149 --buildrequires name:stream
1150 Buildrequires to override in the form of
1151 "name:stream"
1152 --requires name:stream
1153 Requires to override in the form of
1154 "name:stream"
1155 --optional key=value MBS optional arguments in the form of
1156 "key=value". For example: 'fedpkg module-
1157 build --optional
1158 "reuse_components_from=<NSVC>"'. More
1159 description including list of available
1160 arguments here: https://pagure.io/fm-
1161 orchestrator/
1162 --file [FILE_PATH] The modulemd yaml file for module scratch
1163 build.
1164 --srpm SRPMS Include one or more srpms for module scratch
1165 build.
1166
1167
1168 fedpkg new
1169 usage: fedpkg new [-h]
1170
1171 This will use git to show a diff of all the changes (even
1172 uncommitted changes) since the last git tag was applied.
1173
1174 options:
1175 -h, --help show this help message and exit
1176
1177
1178 fedpkg new-sources
1179 usage: fedpkg new-sources [-h] [--offline] files [files ...]
1180
1181 This will upload new source file(s) to lookaside cache, and all file
1182 names listed in sources file will be replaced. .gitignore will be
1183 also updated with new uploaded file(s). Please remember to commit
1184 them.
1185
1186 positional arguments:
1187 files
1188
1189 options:
1190 -h, --help show this help message and exit
1191 --offline Do all the steps except uploading into lookaside cache
1192
1193
1194 fedpkg override
1195 usage: fedpkg override [-h] {create,extend} ...
1196
1197 Manage buildroot overrides.
1198
1199 options:
1200 -h, --help show this help message and exit
1201
1202 subcommands:
1203 Commands on override
1204
1205 {create,extend}
1206 create Create buildroot override from build
1207 extend Extend buildroot override expiration
1208
1209
1210 fedpkg patch
1211 usage: fedpkg patch [-h] [--rediff] suffix
1212
1213 Create and add a gendiff patch file.
1214
1215 positional arguments:
1216 suffix Look for files with this suffix to diff
1217
1218 options:
1219 -h, --help show this help message and exit
1220 --rediff Recreate gendiff file retaining comments Saves old
1221 patch file with a suffix of ~
1222
1223 Patch file will be named: package-version-suffix.patch and the file
1224 will be added to the repo index
1225
1226
1227 fedpkg prep
1228 usage: fedpkg prep [-h] [--builddir BUILDDIR]
1229 [--buildrootdir BUILDROOTDIR] [--arch ARCH]
1230 [--define DEFINE]
1231 ...
1232
1233 Use rpmbuild to "prep" the sources (unpack the source archive(s) and
1234 apply any patches.)
1235
1236 positional arguments:
1237 extra_args Custom arguments that are passed to the
1238 'rpmbuild'. Use '--' to separate them from
1239 other arguments.
1240
1241 options:
1242 -h, --help show this help message and exit
1243 --builddir BUILDDIR Define an alternate builddir
1244 --buildrootdir BUILDROOTDIR
1245 Define an alternate buildrootdir
1246 --arch ARCH Prep for a specific arch
1247 --define DEFINE Pass custom macros to rpmbuild, may specify
1248 multiple times
1249
1250
1251 fedpkg pull
1252 usage: fedpkg pull [-h] [--rebase] [--no-rebase]
1253
1254 This command uses git to fetch remote changes and apply them to the
1255 current working copy. A rebase option is available which can be used
1256 to avoid merges.
1257
1258 options:
1259 -h, --help show this help message and exit
1260 --rebase Rebase the locally committed changes on top of the
1261 remote changes after fetching. This can avoid a merge
1262 commit, but does rewrite local history.
1263 --no-rebase Do not rebase, overriding .git settings to the
1264 contrary
1265
1266 See git pull --help for more details
1267
1268
1269 fedpkg push
1270 usage: fedpkg push [-h] [--force]
1271
1272 Push changes to remote repository.
1273
1274 options:
1275 -h, --help show this help message and exit
1276 --force, -f Force push
1277
1278
1279 fedpkg releases-info
1280 usage: fedpkg releases-info [-h] [-e | -f | -j]
1281
1282 Print Fedora or EPEL current active releases
1283
1284 options:
1285 -h, --help show this help message and exit
1286 -e, --epel Only show EPEL releases.
1287 -f, --fedora Only show Fedora active releases.
1288 -j, --join Show all releases in one line separated by a space.
1289
1290
1291 fedpkg remote
1292 usage: fedpkg remote [-h] {add} ...
1293
1294 Operations with tracked repositories ('remotes'). This is an
1295 experimental interface.
1296
1297 options:
1298 -h, --help show this help message and exit
1299
1300 subcommands:
1301 Operations with tracked repositories ('remotes'). This is an
1302 experimental interface. Please note that some or all current
1303 functionality is subject to change. Without parameters list of
1304 remotes will be shown.
1305
1306 {add}
1307
1308
1309 fedpkg remove-side-tag
1310 usage: fedpkg remove-side-tag [-h] TAG
1311
1312 Remove a side tag (without merging packages).
1313
1314 positional arguments:
1315 TAG name of tag to be deleted
1316
1317 options:
1318 -h, --help show this help message and exit
1319
1320
1321 fedpkg request-branch
1322 usage: fedpkg request-branch [-h] [--repo NAME]
1323 [--namespace {rpms,container,mod‐
1324 ules,flatpaks}]
1325 [--sl [SL ...]] [--no-git-branch]
1326 [--no-auto-module] [--all-releases]
1327 [branch]
1328
1329 Request a new dist-git branch
1330
1331 Please refer to the help of the request-repo command to see what has
1332 to be done before requesting a dist-git branch.
1333
1334 Branch name could be one of current active Fedora and EPEL releases.
1335 Use
1336 command ``fedpkg releases-info`` to get release names that can be
1337 used to request
1338 a branch.
1339
1340 Below are various examples of requesting a dist-git branch.
1341
1342 Request a branch inside a cloned package repository:
1343
1344 fedpkg request-branch f27
1345
1346 Request a branch outside package repository, which could apply to
1347 cases of
1348 requested repository has not been approved and created, or just not
1349 change
1350 directory to package repository:
1351
1352 fedpkg request-branch --repo foo f27
1353
1354 Request a branch with service level tied to the branch. In this case
1355 branch
1356 argument has to be before --sl argument, because --sl allows multiple
1357 values.
1358
1359 fedpkg request-branch branch_name --sl bug_fixes:2020-06-01
1360 rawhide:2019-12-01
1361
1362 positional arguments:
1363 branch The branch to request.
1364
1365 options:
1366 -h, --help show this help message and exit
1367 --repo NAME Repository name the new branch is requested
1368 for.
1369 --namespace {rpms,container,modules,flatpaks}
1370 Repository name the new branch is requested
1371 for.
1372 --sl [SL ...] The service levels (SLs) tied to the branch.
1373 This must be in the format of
1374 "sl_name:2020-12-01". This is only for non-
1375 release branches. You may provide more than
1376 one by separating each SL with a space. When
1377 the argument is used, branch argument has to
1378 be placed before --sl.
1379 --no-git-branch Don't create the branch in git but still
1380 create it in PDC
1381 --no-auto-module If requesting an rpm arbitrary branch, do
1382 not also request a new matching module. See
1383 https://pagure.io/fedrepo_req/issue/129
1384 --all-releases Make a new branch request for every active
1385 Fedora release
1386
1387
1388 fedpkg request-repo
1389 usage: fedpkg request-repo [-h]
1390 [--namespace {rpms,container,modules,flat‐
1391 paks}]
1392 [--description DESCRIPTION]
1393 [--monitor {no-monitoring,monitoring,moni‐
1394 toring-with-scratch}]
1395 [--upstreamurl UPSTREAMURL]
1396 [--summary SUMMARY] [--exception]
1397 [--no-initial-commit]
1398 name [bug]
1399
1400 Request a new dist-git repository
1401
1402 Before the operation, you need to generate a pagure.io API token at:
1403 https://pagure.io/settings/token/new
1404
1405 ACL required:
1406 "Create a new ticket"
1407
1408 Update your token with the following command:
1409 fedpkg set-pagure-token <api_key_here>
1410
1411 Command saves token to fedpkg config file:
1412 ~/.config/rpkg/fedpkg.conf
1413
1414 For example:
1415 [fedpkg.pagure]
1416 token = <api_key_here>
1417
1418 Below is a basic example of the command to request a dist-git reposi‐
1419 tory for
1420 the package foo:
1421
1422 fedpkg request-repo foo 1234
1423
1424 Another example to request a module foo:
1425
1426 fedpkg request-repo --namespace modules foo
1427
1428 positional arguments:
1429 name Repository name to request.
1430 bug Bugzilla bug ID of the package review
1431 request. Not required for requesting a
1432 module repository
1433
1434 options:
1435 -h, --help show this help message and exit
1436 --namespace {rpms,container,modules,flatpaks}
1437 Namespace of repository. If omitted, default
1438 to rpms.
1439 --description DESCRIPTION, -d DESCRIPTION
1440 The repo's description in dist-git
1441 --monitor {no-monitoring,monitoring,monitoring-with-scratch}, -m
1442 {no-monitoring,monitoring,monitoring-with-scratch}
1443 The Anitya monitoring type for the repo
1444 --upstreamurl UPSTREAMURL, -u UPSTREAMURL
1445 The upstream URL of the project
1446 --summary SUMMARY, -s SUMMARY
1447 Override the package's summary from the
1448 Bugzilla bug
1449 --exception The package is an exception to the regular
1450 package review process (specifically, it
1451 does not require a Bugzilla bug)
1452 --no-initial-commit Do not include an initial commit in the
1453 repository.
1454
1455
1456 fedpkg request-side-tag
1457 usage: fedpkg request-side-tag [-h] [--base-tag BASE_TAG]
1458 [--suffix SUFFIX]
1459
1460 Create a new side tag.
1461
1462 options:
1463 -h, --help show this help message and exit
1464 --base-tag BASE_TAG name of base tag
1465 --suffix SUFFIX A suffix to be appended to the side tag name.
1466 The suffix must be allowed in Koji
1467 configuration.
1468
1469
1470 fedpkg request-tests-repo
1471 usage: fedpkg request-tests-repo [-h] [--bug BUG] name description
1472
1473 Request a new dist-git repository in tests shared namespace
1474
1475 https://src.fedoraproject.org/projects/tests/*
1476
1477 For more information about tests shared namespace see
1478
1479 https://fedoraproject.org/wiki/CI/Share_Test_Code
1480
1481 Please refer to the request-repo command to see what has to be done
1482 before
1483 requesting a repository in the tests namespace.
1484
1485 Below is a basic example of the command to request a dist-git reposi‐
1486 tory for
1487 the space tests/foo:
1488
1489 fedpkg request-tests-repo foo "Description of the repository"
1490
1491 Note that the space name needs to reflect the intent of the tests and
1492 will
1493 undergo a manual review.
1494
1495 positional arguments:
1496 name Repository name to request.
1497 description Description of the tests repository
1498
1499 options:
1500 -h, --help show this help message and exit
1501 --bug BUG Bugzilla bug ID of the package review request.
1502
1503
1504 fedpkg retire
1505 usage: fedpkg retire [-h] reason
1506
1507 This command will remove all files from the repo, leave a
1508 dead.package file for rpms or dead.module file for modules, and push
1509 the changes.
1510
1511 positional arguments:
1512 reason Reason for retiring the package/module
1513
1514 options:
1515 -h, --help show this help message and exit
1516
1517
1518 fedpkg scratch-build
1519 usage: fedpkg scratch-build [-h] [--arches [ARCHES ...]] [--md5]
1520 [--nowait] [--target TARGET]
1521 [--background] [--fail-fast]
1522 [--skip-remote-rules-validation]
1523 [--skip-nvr-check]
1524 [--custom-user-metadata CUSTOM_USER_META‐
1525 DATA]
1526 [--srpm [SRPM]] [--srpm-mock]
1527
1528 This command will request a scratch build of the package. Without
1529 providing an srpm, it will attempt to build the latest commit, which
1530 must have been pushed. By default all appropriate arches will be
1531 built.
1532
1533 options:
1534 -h, --help show this help message and exit
1535 --arches [ARCHES ...]
1536 Build for specific arches
1537 --md5 Use md5 checksums (for older rpm hosts)
1538 --nowait Don't wait on build
1539 --target TARGET Define build target to build into
1540 --background Run the build at a low priority
1541 --fail-fast Fail the build immediately if any arch fails
1542 --skip-remote-rules-validation
1543 Don't check if there's a valid gating.yaml
1544 file in the repo, where you can define
1545 additional policies for Greenwave gating.
1546 --skip-nvr-check Submit build to buildsystem without check if
1547 NVR was already built. NVR is constructed
1548 locally and may be different from NVR
1549 constructed during build on builder.
1550 --custom-user-metadata CUSTOM_USER_METADATA
1551 Provide a JSON string of custom metadata to
1552 be deserialized and stored under the build's
1553 extra.custom_user_metadata field
1554 --srpm [SRPM] Build from an srpm. If no srpm is provided
1555 with this option an srpm will be generated
1556 from the current module content.
1557 --srpm-mock Build from an srpm. Source rpm will be
1558 generated in 'mock' instead of 'rpmbuild'.
1559
1560
1561 fedpkg set-distgit-token
1562 usage: fedpkg set-distgit-token [-h] token
1563
1564 Updates the fedpkg.distgit API token in ~/.config/rpkg/fedpkg.conf
1565 file. Tokens are of length 64 and contain only uppercase and
1566 numerical values.
1567
1568 positional arguments:
1569 token The new API token. Can be generated at:
1570 https://src.fedoraproject.org/settings/token/new
1571
1572 options:
1573 -h, --help show this help message and exit
1574
1575
1576 fedpkg set-pagure-token
1577 usage: fedpkg set-pagure-token [-h] token
1578
1579 Updates the fedpkg.pagure API token in ~/.config/rpkg/fedpkg.conf
1580 file. Tokens are of length 64 and contain only uppercase and
1581 numerical values.
1582
1583 positional arguments:
1584 token The new API token. Can be generated at:
1585 https://pagure.io/settings/token/new
1586
1587 options:
1588 -h, --help show this help message and exit
1589
1590
1591 fedpkg sources
1592 usage: fedpkg sources [-h] [--outdir OUTDIR]
1593
1594 Download source files
1595
1596 options:
1597 -h, --help show this help message and exit
1598 --outdir OUTDIR Directory to download files into (defaults to
1599 pwd)
1600
1601
1602 fedpkg srpm
1603 usage: Create a source rpm
1604
1605 This command wraps "rpmbuild -bs", roughly equivalent to:
1606
1607 rpmbuild -bs mypackage.spec --define "_topdir ." --de‐
1608 fine "_sourcedir ." --define "_srcrpmdir ." --define "dist
1609 .el8"
1610
1611 To include files in the SRPM, the files must be in the current
1612 working directory (this depends on the package layout used),
1613 and you must reference each file with SourceXXXX: or PatchXXXX:
1614 directives in your .spec file.
1615
1616 positional arguments:
1617 extra_args Custom arguments that are passed to the
1618 'rpmbuild'. Use '--' to separate them from
1619 other arguments.
1620
1621 options:
1622 -h, --help show this help message and exit
1623 --builddir BUILDDIR Define an alternate builddir
1624 --buildrootdir BUILDROOTDIR
1625 Define an alternate buildrootdir
1626 --arch ARCH Prep for a specific arch
1627 --define DEFINE Pass custom macros to rpmbuild, may specify
1628 multiple times
1629 --md5 Use md5 checksums (for older rpm hosts)
1630 --srpm-mock Create source rpm in 'mock' instead of
1631 'rpmbuild'
1632 --no-clean, -n Only for --srpm-mock: Do not clean chroot
1633 before building package
1634 --no-cleanup-after Only for --srpm-mock: Do not clean chroot
1635 after building if automatic cleanup is
1636 enabled
1637 --no-clean-all, -N Only for --srpm-mock: Alias for both --no-
1638 clean and --no-cleanup-after
1639
1640
1641 fedpkg switch-branch
1642 usage: fedpkg switch-branch [-h] [-l] [--fetch] [branch]
1643
1644 This command can switch to a local git branch. If provided with a
1645 remote branch name that does not have a local match it will create
1646 one. It can also be used to list the existing local and remote
1647 branches.
1648
1649 positional arguments:
1650 branch Branch name to switch to
1651
1652 options:
1653 -h, --help show this help message and exit
1654 -l, --list List both remote-tracking branches and local branches
1655 --fetch Fetch new data from remote before switch
1656
1657
1658 fedpkg tag
1659 usage: fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [--raw] [-F FILE] [-l]
1660 [-d]
1661 [tag]
1662
1663 This command uses git to create, list, or delete tags.
1664
1665 positional arguments:
1666 tag Name of the tag
1667
1668 options:
1669 -h, --help show this help message and exit
1670 -f, --force Force the creation of the tag
1671 -m MESSAGE, --message MESSAGE
1672 Use the given <msg> as the tag message
1673 -c, --clog Generate the tag message from the spec
1674 changelog section
1675 --raw Make the clog raw
1676 -F FILE, --file FILE Take the tag message from the given file
1677 -l, --list List all tags with a given pattern, or all
1678 if not pattern is given
1679 -d, --delete Delete a tag
1680
1681
1682 fedpkg unused-patches
1683 usage: fedpkg unused-patches [-h]
1684
1685 Print list of patches not referenced by name in the specfile.
1686
1687 options:
1688 -h, --help show this help message and exit
1689
1690
1691 fedpkg update
1692 usage: fedpkg update [-h]
1693 [--type {bugfix,security,enhancement,newpack‐
1694 age}]
1695 [--request {testing,stable}]
1696 [--bugs BUGS [BUGS ...]] [--notes NOTES]
1697 [--disable-autokarma] [--stable-karma KARMA]
1698 [--unstable-karma KARMA] [--not-close-bugs]
1699 [--no-require-bugs] [--no-require-testcases]
1700 [--suggest-reboot | --suggest-logout]
1701
1702 This will create a bodhi update request for the current package n-v-
1703 r.
1704
1705 There are two ways to specify update details. Without any argument
1706 from command
1707 line, either update type or notes is omitted, a template editor will
1708 be shown
1709 and let you edit the detail information interactively.
1710
1711 Alternatively, you could specify argument from command line to create
1712 an update
1713 directly, for example:
1714
1715 fedpkg update --type bugfix --notes 'Rebuilt' --bugs 1000 1002
1716
1717 When all lines in template editor are commented out or deleted, the
1718 creation
1719 process is aborted. If the template keeps unchanged, fedpkg continues
1720 on creating
1721 update. That gives user a chance to confirm the auto-generated notes
1722 from
1723 change log if option --notes is omitted.
1724
1725 options:
1726 -h, --help show this help message and exit
1727 --type {bugfix,security,enhancement,newpackage}
1728 Update type. Template editor will be shown
1729 if type is omitted.
1730 --request {testing,stable}
1731 Requested repository.
1732 --bugs BUGS [BUGS ...]
1733 Bug numbers. If omitted, bug numbers will be
1734 extracted from change logs.
1735 --notes NOTES Update description. Multiple lines of notes
1736 could be specified. If omitted, template
1737 editor will be shown.
1738 --disable-autokarma Karma automatism is enabled by default. Use
1739 this option to disable that.
1740 --stable-karma KARMA Stable karma. Default is 3.
1741 --unstable-karma KARMA
1742 Unstable karma. Default is -3.
1743 --not-close-bugs By default, update will be created by
1744 enabling to close bugs automatically. If
1745 this is what you do not want, use this
1746 option to disable the default behavior.
1747 --no-require-bugs Disables the requirement that all of the
1748 bugs in your update have been confirmed by
1749 testers. Default is True.
1750 --no-require-testcases
1751 Disables the requirement that this update
1752 passes all test cases before reaching
1753 stable. Default is True.
1754 --suggest-reboot Suggest user to reboot after update. Default
1755 is False.
1756 --suggest-logout Suggest user to logout after update. Default
1757 is False.
1758
1759
1760 fedpkg upload
1761 usage: fedpkg upload [-h] [--offline] files [files ...]
1762
1763 This command will upload new source file(s) to lookaside cache.
1764 Source file names are appended to sources file, and .gitignore will
1765 be also updated with new uploaded file(s). Please remember to commit
1766 them.
1767
1768 positional arguments:
1769 files
1770
1771 options:
1772 -h, --help show this help message and exit
1773 --offline Do all the steps except uploading into lookaside cache
1774
1775
1776 fedpkg verify-files
1777 usage: fedpkg verify-files [-h] [--builddir BUILDDIR]
1778 [--buildrootdir BUILDROOTDIR]
1779 [--arch ARCH] [--define DEFINE]
1780 ...
1781
1782 Locally run 'rpmbuild -bl' to verify the spec file's %files
1783 sections. This requires a successful run of 'fedpkg install' in
1784 advance.
1785
1786 positional arguments:
1787 extra_args Custom arguments that are passed to the
1788 'rpmbuild'. Use '--' to separate them from
1789 other arguments.
1790
1791 options:
1792 -h, --help show this help message and exit
1793 --builddir BUILDDIR Define an alternate builddir
1794 --buildrootdir BUILDROOTDIR
1795 Define an alternate buildrootdir
1796 --arch ARCH Prep for a specific arch
1797 --define DEFINE Pass custom macros to rpmbuild, may specify
1798 multiple times
1799
1800
1801 fedpkg verrel
1802 usage: fedpkg verrel [-h]
1803
1804 Print the name-version-release.
1805
1806 options:
1807 -h, --help show this help message and exit
1808
1809
1811 https://pagure.io/fedpkg/
1812
1813
1814
1815 2022-09-08 fedpkg(1)