Repository navigation
Document that the CLI uses top-level configuration for shared keys - #1181
Open
Nitjsefnie wants to merge 1 commit into
Open
Nitjsefnie wants to merge 1 commit into
Nitjsefnie wants to merge 1 commit into
Conversation
Explain which configuration ordinary CLI workflows use when shared keys differ between package and job levels. Describe the commands that read job-level values, validation behavior, CLI option precedence, and how Packit Service applies job overrides. Signed-off-by: Nitjsefnie <zmatek.peter@gmail.com> Co-Authored-By: GPT-6.1 Sol <noreply@openai.com>
Contributor
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 10s |
Contributor
Author
|
Heads-up: this branch lives in an organization-owned fork, and GitHub doesn't let maintainers push to those. If anything needs changing, just say so here and I'll make the change on this branch right away. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents which configuration values the ordinary Packit CLI uses for keys that exist both at top level and at job level (for example
actionsorversion_update_mask), and which CLI commands do read job-level values.Related Issues and Pull Requests
Fixes #1083
Changes
docs/configuration/jobs.md: new "CLI configuration" note after the job-level override example — job-level values of shared keys are accepted and validated and become part of the job's effective configuration (used by Packit Service), while ordinary CLI commands use the package configuration (top-level, or package-level withpackages); enumerates the exceptions (prepare-sources --job-config-index, experimentalbuild in-image-builder,propose-downstream/pull-from-upstreamreading the matching job'sdist_git_branches,build in-coprreading the qualifying job'sprojectwhen--projectis absent,validate/config validate); notes that invalid job-level values can still fail loading or validation, and that CLI options take precedence.docs/configuration/index.md: qualifies the "Both Packit Service and Packit CLI use this configuration file" statement and links to the new section.docs/cli/index.md: cross-link from the Commands section to the same explanation.Testing
Docs-only change, checked by the site build (
make import+yarn build). Gates that ran, all green on head5250e718c28f6a4cdb84287bc3d00032951b05ab: fork CIosc-manual.ymlrun 39831603023 (provenance echo names that SHA), upstream Test deployment (run 39832638211), Zuulpackit-service/check, and pre-commit.ci. The documented behavior was verified against current packit/packit source: the configuration loader merges job-level shared keys into the job's effective configuration while CLI commands receive the package configuration, with the listed commands consuming job-level values.Footer
Generated by GLM-5.3-Flash (brief), GPT-6.1 Sol (implementation), GPT-6 Astra (review)