-
-
Notifications
You must be signed in to change notification settings - Fork 422
Document breaking change to config get command output
#2676
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.
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
Merged
per1234
merged 2 commits into
arduino:master
from
per1234:document-config-dump-breaking-change
Jul 29, 2024
Merged
Document breaking change to config get command output
#2676
per1234
merged 2 commits into
arduino:master
from
per1234:document-config-dump-breaking-change
Jul 29, 2024
Conversation
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
Previously, the `config dump` CLI command returned the effective configuration, including both the values explicitly set via the configuration file and environment variables as well as the values provided by defaults. It was changed to only return the explicitly set configuration data. The breaking change was not documented at that time.
@per1234
per1234
added
topic: documentation
Related to documentation for the project
type: imperfection
Perceived defect in any part of project
labels
Jul 29, 2024
3 tasks
alessio-perugini
alessio-perugini
approved these changes
Jul 29, 2024
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.
What kind of change does this PR introduce?
Documentation update
What is the current behavior?
Previously, the
config dumpCLI command returned the effective configuration, including both the values explicitly set via the configuration file and environment variables as well as the values provided by defaults.It was changed to only return the explicitly set configuration data (1fddba7). The breaking change was not documented at that time.
What is the new behavior?
The breaking change is documented in the "Upgrading" document in compliance with the project's development policies.
The new approach for getting the effective configuration values is also documented there.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change
Other information
Related:
config dumpcommands doesn't print default values #2637