Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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.
Comment on lines +36 to +38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@betulependule I guess it got merged with the underscores anyways 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I completely missed these errors. 👀 I'll fix the other instances where dashes need to be replaced with underscores in this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the underscores where intentional? 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can push new commits to this PR, right? 😅

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's auto-generated, if you're going to adjust this specific section (the help for init), it will get overwritten next week anyways :D

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I took a look at the code and underscores are being used. 😅
I can make a new PR and change it in Packit to dashes if that would be better.

https://github.com/packit/packit/blob/f1ebbe077647d8d70f3821126a7839d0f386b5b3/packit/cli/init.py#L44-L55

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better for the consistency with other options :/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, tomorrow I'll make a new issue and fix it in Packit. 👍

-h, --help Show this message and exit.
35 changes: 15 additions & 20 deletions docs/cli/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,26 +83,21 @@ 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 without needing a PR or release
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(s) to RPMs that should be installed in
the test environment.
--target TEXT Container/VM image to use.
--plans TEXT List of specific tmt plans to run.
--clean-before / --no-clean-before
Run 'tmt clean --all' before starting the
test (default: disabled).
-h, --help Show this message and exit.