Skip to content

docs: document build_args_file knob in config reference#1340

Open
jlebon wants to merge 1 commit intocoreos:mainfrom
jlebon:pr/doc-build-args
Open

docs: document build_args_file knob in config reference#1340
jlebon wants to merge 1 commit intocoreos:mainfrom
jlebon:pr/doc-build-args

Conversation

@jlebon
Copy link
Copy Markdown
Member

@jlebon jlebon commented Apr 30, 2026

Assisted-by: Pi (Claude Opus 4.6)

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new build_args_file configuration option in docs/config.yaml for node image builds. The review feedback suggests updating the example value to false to align with its documented default and refining the example filename to match the specific release version referenced in the configuration block for better clarity.

Comment thread docs/config.yaml
Comment on lines +341 to +344
# 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
Copy link
Copy Markdown

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

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.

1 participant