Add DefaultFunc to repo ruleset required deploy env, base role IDs to docs #1916
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.
Resolves #1915
Before the change?
rules.required_deployments.required_deployment_environments
, the following is what we get:required_deployments:[<nil>]
The reason it's bad is because we want to be able to strictly specify an empty list, the GitHub API accepts that as a valid input.
The reason it's set to nil is because the elements of
rules.required_deployments
are pointers, an empty slice is the zero value and thus treated as a nil pointer.After the change?
DefaultFunc
to return an empty slice gives us the following:required_deployments:[map[required_deployment_environments:[]]]
The API accepts this as a valid input and can successfully apply changes. It also doesn't affect anything that's existing since any input overrides the
DefaultFunc
.Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!