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
usercont-release-bot 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
8 changes: 5 additions & 3 deletions docs/cli/init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ initialize a [source-git repo](/source-git).

Usage: packit init [OPTIONS] [PATH_OR_URL]

Create the initial Packit configuration in a repository
Create the initial Packit configuration in a repository and add a pre-commit
hook to validate Packit configuration file

See 'packit source-git init', if you want to initialize a repository as a
source-git repo.

Options:
--force-precommit Automatically create an empty pre-commit configuration file if missing.
--without-precommit Skip adding pre-commit hook to pre-commit configuration file.
-f, --force Reset config to default if already exists.
--without-precommit Skip adding packit-specific pre-commit configuration
hook.
--force-precommit Create pre-commit configuration file if missing.
-h, --help Show this message and exit.
43 changes: 23 additions & 20 deletions docs/cli/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,26 +83,29 @@ The command supports two main workflows:

## Help

Usage: packit test [OPTIONS]
Usage: packit test [OPTIONS] [PATH_OR_URL]

Run tmt tests locally using content from the upstream repository.
This command builds RPMs from the current repository state and runs
tests in containerized environments, mimicking Packit's testing service
behavior for local debugging and development.
Run tmt tests locally using content from the upstream repository.

This command builds RPMs from the current repository state and runs tests in
containerized environments, mimicking Packit's testing service behavior for
local debugging and development.

Options:
--rpm-paths PATH Path to RPM file(s) to test. Can be used
multiple times. If not provided, RPMs will
be built automatically from source.
--target TEXT Container image for testing environment
(e.g., 'fedora:39', 'centos:stream9').
Defaults to 'fedora:rawhide'.
--plans TEXT tmt plan name(s) to execute. Can be used
multiple times to run specific plans only.
If not specified, all plans are executed.
--clean-before / --no-clean-before
Run 'tmt clean --all' before starting the
test. Defaults to disabled for clean test
environments.
-h, --help Show this message and exit.
-p, --package TEXT Package to source 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.
--rpm_paths TEXT Path to RPM file(s) to test. Can be used
multiple times.If not provided, RPMs will be
built automatically from source.
--target TEXT Container image for the testing environment,
e.g., `fedora:39`, `centos:stream9`.
--plan TEXT List of specific tmt plans to run. Can be
used multiple times. If not specified, all
plans are executed.
--clean-before / --no-clean-before
Run 'tmt clean --all' before starting the
test (default: disabled).
-h, --help Show this message and exit.