Document the _ placeholder
#971
Merged
Conversation
This file contains 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
2 tasks
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 23s |
LecrisUT
commented
Nov 13, 2024
LecrisUT
force-pushed
the
yaml-placeholder
branch
from
785d17c to
1f8b862
Compare
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 20s |
mfocko
reviewed
Nov 14, 2024
softwarefactory-project-zuul bot
added a commit
to packit/packit
that referenced
this pull request
Nov 15, 2024
Add a yaml placeholder
Users can use this placeholder to put anchors that would otherwise be invalid keys in the config file, e.g.
_:
internal-test: &internal-test
job: tests
use_internal_tf: True
jobs:
- <<: *internal-test
targets: [ fedora-latest ]
tmt_plan: "/plans/core"
- <<: *internal-test
targets: [ epel-9 ]
require:
label:
present:
- full
Notice how in this example we cannot create a reusable anchor from either the fedora or the epel job because it would automatically inherit either tmt_plan or require.* values. Allowing a placeholder where one could define some definitions for later usage would make designing the yaml file a bit easier in some cases.
Feel free to propose any naming convention for this placeholder
TODO:
Write new tests or update the old ones to cover new functionality.
Update or write new documentation in packit/packit.dev.
packit/packit.dev/pull/971
Fixes
Related to
Merge before/after
RELEASE NOTES BEGIN
Packit configuration file can now have a placeholder top-level key _ that is ignored when read.
This is useful for storing yaml anchors in complex config files, e.g.:
_:
base-test: &base-test
job: tests
fmf_path: .distro
jobs:
- <<: *base-test
trigger: pull_request
manual_trigger: true
- <<: *internal-test
trigger: commit
use_internal_tf: true
RELEASE NOTES END
Reviewed-by: Matej Focko
Reviewed-by: Laura Barcziová
mfocko
approved these changes
Nov 15, 2024
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 40s |
|
Build succeeded (gate pipeline). ✔️ pre-commit SUCCESS in 1m 23s |
softwarefactory-project-zuul
bot
merged commit 1718cd4
into
packit:main
4 checks passed
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.
Related to packit/packit/pull/2378