Skip to content

Conversation

kayodegigz
Copy link
Contributor

Documentation for packit test command

Fixes

Related to

Merge before/after

RELEASE NOTES BEGIN

Packit now supports automatic ordering of ☕ after all checks pass.

RELEASE NOTES END

Copy link
Contributor

docs/cli/test.md Outdated

# `packit test`

Run TMT tests locally using content from the upstream repository, mimicking the behavior of the tmt functionality.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Run TMT tests locally using content from the upstream repository, mimicking the behavior of the tmt functionality.
Run tmt tests locally using content from the upstream repository, mimicking the behavior of the tmt functionality.

docs/cli/test.md Outdated

Run TMT tests locally using content from the upstream repository, mimicking the behavior of the tmt functionality.

By default, (if no rpm paths are passed), packit builds RPMs from the current repository's spirce code using Mock, then runs TMT tests in a container environment. This enables local debugging and iteration without requiring commits or CI pipeline triggers.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
By default, (if no rpm paths are passed), packit builds RPMs from the current repository's spirce code using Mock, then runs TMT tests in a container environment. This enables local debugging and iteration without requiring commits or CI pipeline triggers.
By default, if no RPM paths are passed, packit builds RPMs from the current repository's source code using `mock`, then runs tmt tests in a container environment. This enables local debugging and iteration without requiring commits or CI pipeline triggers.

docs/cli/test.md Outdated

By default, (if no rpm paths are passed), packit builds RPMs from the current repository's spirce code using Mock, then runs TMT tests in a container environment. This enables local debugging and iteration without requiring commits or CI pipeline triggers.

You can override test behavior and build configuration directly from the command line using various options like --target, --plans, --rpm-paths, and --clean-before/--no-clean-before.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can override test behavior and build configuration directly from the command line using various options like --target, --plans, --rpm-paths, and --clean-before/--no-clean-before.
You can override test behavior and build configuration directly from the command line using various options like `--target`, `--plans`, `--rpm-paths`, and `--clean-before`/`--no-clean-before`.

docs/cli/test.md Outdated

The command supports two main workflows:

- Auto-build workflow: Build RPMs from source code and run tmt tests on the built rpm. This is trggered when there's no --rpm_paths passed via the cli.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Auto-build workflow: Build RPMs from source code and run tmt tests on the built rpm. This is trggered when there's no --rpm_paths passed via the cli.
- Auto-build workflow: Build RPMs from source code and run tmt tests on the built RPM. This is triggered when there's no `--rpm-paths` passed via the CLI.

docs/cli/test.md Outdated
The command supports two main workflows:

- Auto-build workflow: Build RPMs from source code and run tmt tests on the built rpm. This is trggered when there's no --rpm_paths passed via the cli.
- Pre-built RPM workflow: Test existing RPM files, Paths to the rpm(s) are passed with the `--rpm_paths` option.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Pre-built RPM workflow: Test existing RPM files, Paths to the rpm(s) are passed with the `--rpm_paths` option.
- Pre-built RPM workflow: Test existing RPM files, Paths to the RPMs are passed with the `--rpm-paths` option.

docs/cli/test.md Outdated

* Upstream project is using git.
* Packit config file placed in the upstream repository.
* TMT (Test Management Tool) available in the system.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* TMT (Test Management Tool) available in the system.
* `tmt` (Test Management Tool) available in the system.

docs/cli/test.md Outdated

## Tutorial

1. Place a config file for packit in the root of your upstream repository...
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. Place a config file for packit in the root of your upstream repository...
1. Place a config file for packit in the root of your upstream repository.

@kayodegigz
Copy link
Contributor Author

Hi @mfocko , I've made the changes

Copy link
Contributor

Copy link
Member

@majamassarini majamassarini left a comment

Choose a reason for hiding this comment

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

I like this documentation. Thanks! I have added just two small changes (if you want to apply them). But most importantly, you need to rebase your PR.


The command supports two main workflows:

- Auto-build workflow: Build RPMs from source code and run tmt tests on the built RPM. This is triggered when there's no `--rpm-paths` passed via the CLI.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Auto-build workflow: Build RPMs from source code and run tmt tests on the built RPM. This is triggered when there's no `--rpm-paths` passed via the CLI.
- Auto-build workflow: build RPMs from source code and run tmt tests on the built RPM. This is triggered when there's no `--rpm-paths` passed via the CLI.

The command supports two main workflows:

- Auto-build workflow: Build RPMs from source code and run tmt tests on the built RPM. This is triggered when there's no `--rpm-paths` passed via the CLI.
- Pre-built RPM workflow: Test existing RPM files, Paths to the RPMs are passed with the `--rpm-paths` option.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Pre-built RPM workflow: Test existing RPM files, Paths to the RPMs are passed with the `--rpm-paths` option.
- Pre-built RPM workflow: test existing RPM files, Paths to the RPMs are passed with the `--rpm-paths` option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants