(maint) Update optional parameters #671
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
mhashizume
force-pushed
the
maint/main/optional-parameters
branch
5 times, most recently
from
4415e16 to
39a5d08
Compare
As part of 404df9d all parameters in this module were assigned a data type. However, some required parameters were mistakenly classed as Optional and vice-versa. Puppet's documentation states "If a class parameter lacks a default value, the parameter is considered required."[1] This commit updates all parameters with default values to Optional (and whatever other relevant data type) and all parameters without default value as required. The REFERENCE.md has been updated to reflect these changes. Additionally, this commit updates all Optional parameters be set as undef, as suggested by the optional_default puppet-lint check. [1] https://www.puppet.com/docs/puppet/7/lang_classes#class-parameters-and-variables
mhashizume
force-pushed
the
maint/main/optional-parameters
branch
from
39a5d08 to
74e022d
Compare
mhashizume
added
the
maintenance
AriaXLi
approved these changes
Sep 26, 2023
mhashizume
added
bug
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.
As part of 404df9d all parameters in this module were assigned a data type. However, some required parameters were mistakenly classed as Optional and vice-versa.
Puppet's documentation states "If a class parameter lacks a default value, the parameter is considered required."[1]
This commit updates all parameters with default values to Optional (and whatever other relevant data type) and all parameters without default value as required. The REFERENCE.md has been updated to reflect these changes.
Additionally, this commit updates all Optional parameters be set as undef, as suggested by the optional_default puppet-lint check.
[1] https://www.puppet.com/docs/puppet/7/lang_classes#class-parameters-and-variables