Skip to content

Update documentation w.r.t. ignoreDefaultValue: true#2750

Open
Vlatombe wants to merge 1 commit intoupdatecli:masterfrom
Vlatombe:ignoreDefaultValue
Open

Update documentation w.r.t. ignoreDefaultValue: true#2750
Vlatombe wants to merge 1 commit intoupdatecli:masterfrom
Vlatombe:ignoreDefaultValue

Conversation

@Vlatombe
Copy link

@Vlatombe Vlatombe commented Mar 6, 2026

updatecli/updatecli#7870

Fix #7841

Test

This project uses Netlify to generate preview environment,
so feel free to look there directly to see how this pullrequest render

Additional Information

Tradeoff

Potential improvement

@Vlatombe Vlatombe marked this pull request as ready for review March 6, 2026 11:47
* When used as a target, *only* the value of the argument (right of the `=` when present)
** When no argument value is found (e.g. default value, no character `=` or empty value),
then updatecli appends the `=` character followed by the value.
then updatecli appends the `=` character followed by the value. It is possible to disable this behaviour by providing `ignoreDefaultValue: true` in the configuration.
Copy link
Member

@lemeurherve lemeurherve Mar 6, 2026

Choose a reason for hiding this comment

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

Non-blocking: WDYT of ignoreNoArgValue, or (englobing ENV) ignoreUnspecifiedValue?

I find "default" a bit confusing and less immediate to understand. (personal opinion)

Copy link
Author

Choose a reason for hiding this comment

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

I named the argument based on the existing documentation, which is IMO a bit confusing, since the official docker doc refers to "default" value as the literal value that may be specified. But we could also adjust the documentation to be more aligned with https://docs.docker.com/reference/dockerfile/#default-values.

Maybe ignoreMissingValue would make sense (I don't really like unspecified, too long).

Copy link
Member

@lemeurherve lemeurherve Mar 6, 2026

Choose a reason for hiding this comment

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

nit: "Missing" is a bit misleading as it's generally a choice of not specifying any value, not something missing (forgotten) per se.

To go along with the official docker doc, WDYT of ignoreNoDefaultValue or ignoreNoDefault (shorter)?

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.

2 participants