Skip to content

Improve wording and add missing documentation for rmdepcheck and license-validate #1169

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
betulependule wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve wording and add missing documentation for rmdepcheck and license-validate #1169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f07689
Improve wording of Fedora CI test jobs documentation
betulependule Aug 31, 2026
15c5979
Add documentation for `rmdepcheck` and `license-validate` identifiers
betulependule Aug 31, 2026
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
36 changes: 24 additions & 12 deletions fedora-ci/jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,39 @@ Scratch builds in [Koji](https://koji.fedoraproject.org/koji/) built from SCM.

## Tests

### Installability
Each of the following tests is run in [Testing Farm](https://testing-farm.io)
automatically with a successful scratch build.

[Installability test](https://github.com/fedora-ci/installability-pipeline)
in [Testing Farm](https://testing-farm.io) run with a successful scratch build.
### installability

[installability test](https://github.com/fedora-ci/installability-pipeline),

@fullsend-ai-review fullsend-ai-review Bot Aug 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] naming-convention

The heading ### installability uses all-lowercase, diverging from the sentence-case convention used in higher-level headings (e.g., ## Scratch builds). However, within the ## Tests section, the pre-existing headings ### rpmlint and ### rpminspect already used lowercase as canonical tool names. This PR normalizes installability to match its siblings and the exact CLI identifier used in /packit-ci test installability — a defensible editorial choice.

Suggested fix: If the project prefers sentence case for all headings, change to ### Installability. Otherwise, the current lowercase is consistent with sibling test headings.

which checks that the built RPMs/SRPMs install cleanly, together with their dependencies.

### rpmlint

[rpmlint](https://github.com/rpm-software-management/rpmlint)
[test](https://github.com/packit/tmt-plans/tree/main/plans/rpmlint)
in [Testing Farm](https://testing-farm.io) run with a successful scratch build.
[rpmlint test](https://github.com/packit/tmt-plans/tree/main/plans/rpmlint), which is
based on [rpmlint](https://github.com/rpm-software-management/rpmlint).
Lints the built RPM/SRPM packages against Fedora packaging guidelines.

### rpminspect

[rpminspect](https://github.com/rpminspect/rpminspect)
[test](https://github.com/fedora-ci/rpminspect-pipeline)
in [Testing Farm](https://testing-farm.io) run with a successful scratch build.
[rpminspect test](https://github.com/fedora-ci/rpminspect-pipeline), which runs
[rpminspect](https://github.com/rpminspect/rpminspect) on the built RPM/SRPM packages.

### rmdepcheck

[rmdepcheck test](https://forge.fedoraproject.org/ci/shared-tests/src/branch/main/rmdepcheck),
which performs an RPM dependency check.

### license-validate

[license-validate test](https://forge.fedoraproject.org/ci/shared-tests/src/branch/main/license-validate),
which validates that the package's license defined in the .spec file
is [approved](https://docs.fedoraproject.org/en-US/legal/license-approval/#Software_License_List).

### Custom test plans
### custom test plans

@fullsend-ai-review fullsend-ai-review Bot Aug 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] naming-convention

The heading ### custom test plans uses all-lowercase, changed from the previous ### Custom test plans. Unlike tool-name headings (rpmlint, rpminspect, installability), 'custom test plans' is a descriptive phrase rather than a canonical tool identifier, so the case for keeping it capitalized is stronger. The PR is establishing a uniform lowercase style for all test sub-headings to match their CLI identifiers.

Suggested fix: Consider restoring to ### Custom test plans since this is a descriptive phrase, not a tool name. Alternatively, if the project decides all test headings should match their CLI identifiers, the lowercase is acceptable.

Custom [TMT](https://tmt.readthedocs.io/) test plans in [Testing Farm](https://testing-farm.io)
run with a successful scratch build. This requires TMT metadata (`.fmf/version` presence used as an indicator)
Custom [TMT](https://tmt.readthedocs.io/) test plans, which require TMT metadata (`.fmf/version` presence used as an indicator)
in the dist-git repository and at least one [test plan](https://tmt.readthedocs.io/en/stable/spec/plans.html)
in `plans`.

Expand Down
8 changes: 5 additions & 3 deletions fedora-ci/retriggering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can retrigger CI jobs in dist-git pull requests by posting comments that inc
Fedora CI runs in two stages:

1. **Scratch build** — a Koji scratch build is created from the pull request.
2. **Tests** — once the scratch build succeeds, all configured tests (installability, rpmlint, rpminspect, custom TMT plans) are automatically triggered.
2. **Tests** — once the scratch build succeeds, all configured tests (installability, rpmlint, rpminspect, rmdepcheck, license-validate, custom TMT plans) are automatically triggered.

Because tests depend on a successful scratch build, **retriggering a scratch build will also cause tests to re-run** once the new build succeeds. If you only need to re-run the tests (for example, because a test failed due to a transient infrastructure issue but the scratch build was fine), you can retrigger just the tests without rebuilding.

Expand Down Expand Up @@ -52,10 +52,12 @@ To retrigger a specific test, you can add the test identifier to the command:

Currently supported identifiers are:

- `installability` - represents the [Installability](/fedora-ci/jobs#installability) test
- `installability` - represents the [installability](/fedora-ci/jobs#installability) test
- `rpmlint` - represents the [rpmlint](/fedora-ci/jobs#rpmlint) test
- `rpminspect` - represents the [rpminspect](/fedora-ci/jobs#rpminspect) test
- `custom` - represents [Custom TMT test plans](/fedora-ci/jobs#custom-test-plans)
- `rmdepcheck` - represents the [rmdepcheck](/fedora-ci/jobs#rmdepcheck) test
- `license-validate` - represents the [license-validate](/fedora-ci/jobs#license-validate) test
- `custom` - represents [custom TMT test plans](/fedora-ci/jobs#custom-test-plans)

Only packagers can retrigger tests.

Expand Down
Loading