Skip to content

docs: document build_args_file knob in config reference #1340

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
jlebon wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

docs: document build_args_file knob in config reference #1340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,10 @@ ocp_node_builds:
file: rhel-9.6.repo
# OPTIONAL: skip upload to brew. Defaults to false
skip_brew_upload: false
# OPTIONAL: pass a build-args file to `cosa remote-build-container`
# during node image builds. The filename is derived from the release
# (e.g. build-args-9.8-4.22.conf). Defaults to false.
build_args_file: true
Comment on lines +341 to +344
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

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

medium

The documentation states that build_args_file defaults to false, but the example shows it set to true. For consistency with the adjacent skip_brew_upload entry and to clearly reflect the default state in this reference, it is recommended to set it to false. Additionally, updating the example filename to build-args-9.6-4.19.conf would align it with the release version (4.19-9.6) used in this configuration block, making the derivation logic more obvious to the reader.

           # OPTIONAL: pass a build-args file to cosa remote-build-container
           # during node image builds. The filename is derived from the release
           # (e.g. build-args-9.6-4.19.conf). Defaults to false.
           build_args_file: false

# REQUIRED: knobs related to the source config
registries:
# REQUIRED: staging repo to push the final image built
Expand Down