Skip to content

Update help messages of CLI commands #1064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update help messages of CLI commands #1064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 0 additions & 57 deletions docs/cli/build/in-copr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,61 +35,4 @@ for more details). Alternatively you can use copr API token available [here](htt

## Help

Usage: packit build in-copr [OPTIONS] [PATH_OR_URL]

Build selected upstream project in Copr.

PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory.

Copr configuration needs to be set before usage.
https://docs.pagure.org/copr.copr/user_documentation.html#quick-start

Options:
--wait / --no-wait Wait for the build to finish
--owner TEXT Copr user, owner of the project. (defaults
to username from copr config)
--project TEXT Project name to build in. Will be created if
does not exist. (defaults to the first found
project value in the config file or 'packit-
cli-{repo_name}-{branch/commit}')
--targets TEXT Comma separated list of chroots to build in.
(defaults to 'fedora-rawhide-x86_64')
--description TEXT Description of the project to build in.
--instructions TEXT Installation instructions for the project to
build in.
--list-on-homepage Created copr project will be visible on
copr's home-page.
--preserve-project Created copr project will not be removed
after 60 days.
--additional-repos TEXT URLs to additional yum repos, which can be
used during build. Comma separated. This
should be baseurl from .repo file. E.g.:
http://copr-be.cloud.fedoraproject.org/resul
ts/rhughes/f20-gnome-3-12/fedora-$releasever
-$basearch/
--bootstrap [default|on|off|image]
mock bootstrap feature setup.
--upstream-ref TEXT Git ref of the last upstream commit in the
current branch from which packit should
generate patches (this option implies the
repository is source-git).
--request-admin-if-needed Ask for admin permissions when we need to
change settings of the copr project and are
not allowed to do so.
--enable-net / --disable-net Copr build is built with explicitly enabled
network access or disabled
--release-suffix TEXT Specifies release suffix. Allows to override
default generated:{current_time}.{sanitized_
current_branch}{git_desc_suffix}
--default-release-suffix Allows to use default, packit-generated,
release suffix when some release_suffix is
specified in the configuration.
--module-hotfixes Created copr project will have
module_hotfixes set to True
-p, --package TEXT Package to build, if more than one
available, like in a monorepo configuration.
Use it multiple times to select multiple
packages.Defaults to all the packages listed
inside the config.
-h, --help Show this message and exit.
31 changes: 0 additions & 31 deletions docs/cli/build/in-image-builder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,35 +39,4 @@ Builder, for more details see the `vm_image_build` job description.

## Help

Usage: packit build in-image-builder [OPTIONS] IMAGE_NAME [PATH_OR_URL]

Create a VM image in Image Builder.

### EXPERIMENTAL ###

This command is experimental and the integration with Image Builder will be
changed in a backwards incompatible way in the future.

Packit loads image build configuration from your packit.yaml file.

When `--job-config-index` is not specified, the job configuration is loaded
from your .packit.yaml and the first matching vm_image_build job is used.

IMAGE_NAME is the name of the image to be created. Please pick something
unique so it's easy to identify for you in the Image Builder interface and
can be well associated with the image content.

[PATH_OR_URL] argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory

Options:
--job-config-index INTEGER Use N-th job definition to load configuration
for the image build. The type needs to be
vm_image_build.
--wait / --no-wait Wait for the build to finish
-p, --package TEXT Package to build, if more than one available,
like in a monorepo configuration. Use it
multiple times to select multiple
packages.Defaults to all the packages listed
inside the config.
-h, --help Show this message and exit.
35 changes: 1 addition & 34 deletions docs/cli/build/in-koji.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,37 +26,4 @@ Submit a Koji build for the selected branch in Fedora dist-git.

## Help

Usage: packit build in-koji [OPTIONS] [PATH_OR_URL]

Build selected upstream project in Fedora.

By default, packit checks out the respective dist-git repository and
performs `fedpkg build` for the selected branch. With `--from-upstream`,
packit creates a SRPM out of the current checkout and sends it to koji.

PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory

Options:
--dist-git-branch TEXT Comma separated list of target branches in dist-
git to release into. (defaults to repo's default
branch)
--dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone
the repo in a temporary directory.
--from-upstream Build the project in koji directly from the
upstream repository
--koji-target TEXT Koji target to build inside (see `koji list-
targets`).
--scratch Submit a scratch koji build
--wait / --no-wait Wait for the build to finish
--release-suffix TEXT Specifies release suffix. Allows to override
default generated:{current_time}.{sanitized_curren
t_branch}{git_desc_suffix}
--default-release-suffix Allows to use default, packit-generated, release
suffix when some release_suffix is specified in
the configuration.
-p, --package TEXT Package to build, if more than one available, like
in a monorepo configuration. Use it multiple times
to select multiple packages.Defaults to all the
packages listed inside the config.
-h, --help Show this message and exit.

28 changes: 0 additions & 28 deletions docs/cli/build/in-mock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,4 @@ packit build in-mock --root=fedora-40-x86_64

## Help

Usage: packit build in-mock [OPTIONS] [PATH_OR_URL]

Build RPMs in mock using content of the upstream repository.

PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory.

Options:
--upstream-ref TEXT Git ref of the last upstream commit in the current
branch from which packit should generate patches
(this option implies the repository is source-
git).
--release-suffix TEXT Specifies release suffix. Allows to override
default generated:{current_time}.{sanitized_curren
t_branch}{git_desc_suffix}
--default-release-suffix Allows to use default, packit-generated, release
suffix when some release_suffix is specified in
the configuration.
-r, --root TEXT Uses specified chroot configuration. If ends with
'.cfg', then it is treated as full path to the
mock configuration.
--default-resultdir Use the default result directory from mock
--resultdir DIRECTORY Specifies the resultdir option for ‹mock› command,
for details see mock(1)
-p, --package TEXT Package to build, if more than one available, like
in a monorepo configuration. Use it multiple times
to select multiple packages.Defaults to all the
packages listed inside the config.
-h, --help Show this message and exit.
26 changes: 1 addition & 25 deletions docs/cli/build/in-obs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,4 @@ Submit a build of the present content in the upstream or local repository to [OB
```
## Help

Usage: packit build in-obs [OPTIONS] [PATH_OR_URL]

Build selected project in OBS

Before Running this command, your opensuse user account and password needs
to be configured in osc configuration file ~/.config/osc/oscrc. This can be
done by running `osc`.

Options:
--owner TEXT OBS user, owner of the project. (defaults to the
username from the oscrc)
--project TEXT Project name to build in. It will be created if does
not exist. It defaults to home:$owner:packit:$pkg
--targets TEXT Comma separated list of chroots to build in. (defaults
to 'fedora-rawhide-x86_64')
--description TEXT Description of the project to build in.
--upstream-ref TEXT Git ref of the last upstream commit in the current
branch from which packit should generate patches (this
option implies the repository is source-git).
--wait / --no-wait Wait for the build to finish
-p, --package TEXT Package to build, if more than one available, like in a
monorepo configuration. Use it multiple times to select
multiple packages.Defaults to all the packages listed
inside the config.
-h, --help Show this message and exit.

22 changes: 0 additions & 22 deletions docs/cli/build/locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,4 @@ Create RPMs using content of the upstream repository.

## Help

Usage: packit build locally [OPTIONS] [PATH_OR_URL]

Create RPMs using content of the upstream repository.

PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory

Options:
--upstream-ref TEXT Git ref of the last upstream commit in the current
branch from which packit should generate patches
(this option implies the repository is source-
git).
--release-suffix TEXT Specifies release suffix. Allows to override
default generated:{current_time}.{sanitized_curren
t_branch}{git_desc_suffix}
--default-release-suffix Allows to use default, packit-generated, release
suffix when some release_suffix is specified in
the configuration.
-p, --package TEXT Package to build, if more than one available, like
in a monorepo configuration. Use it multiple times
to select multiple packages.Defaults to all the
packages listed inside the config.
-h, --help Show this message and exit.
16 changes: 0 additions & 16 deletions docs/cli/config/validate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,4 @@ Validate the Packit configuration file.

## Help

Usage: packit config validate [OPTIONS] [PATH_OR_URL]

Validate PackageConfig.

- checks missing values
- checks incorrect types
- checks whether monitoring is enabled if 'pull_from_upstream` is used

PATH_OR_URL argument is a local path or a URL to a git repository with
packit configuration file config: Optional path to a specific Packit
configuration file.

Options:
--offline Do not make remote API calls requiring network
access.
-c, --config-path PATH Path to a specific Packit configuration file.
-h, --help Show this message and exit.
33 changes: 0 additions & 33 deletions docs/cli/create-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,37 +44,4 @@ have an active Kerberos TGT, you will be automatically authenticated.

## Help

Usage: packit create-update [OPTIONS] [PATH_OR_URL]

Create a bodhi update for the selected upstream project

If you are not authenticated with the bodhi server, please make sure that
you navigate in your browser to the URL provided by the bodhi-client and
then paste the `code=XX...` to the terminal when prompted.

If you set `fas_user` and `kerberos_realm` in your "~/.config/packit.yaml"
and have an active Kerberos TGT, you will be automatically authenticated.
Otherwise, you need to follow the prompt

PATH_OR_URL argument is a local path or a URL to the upstream git
repository, it defaults to the current working directory

Options:
--dist-git-branch TEXT Comma separated list of target branches in
dist-git to create bodhi update in.
(defaults to repo's default branch)
--dist-git-path TEXT Path to dist-git repo to work in. Otherwise
clone the repo in a temporary directory.
--koji-build TEXT Koji build (NVR) to add to the bodhi update
(can be specified multiple times)
--update-notes TEXT Bodhi update notes
--update-type [security|bugfix|enhancement|newpackage]
Type of the bodhi update
-b, --resolve-bug TEXT Bugzilla IDs that are resolved with the
update, e.g., rhbz#1234
-p, --package TEXT Package to update, if more than one
available, like in a monorepo configuration.
Use it multiple times to select multiple
packages.Defaults to all the packages listed
inside the config.
-h, --help Show this message and exit.
Loading