Skip to content

[DOCS]: github_organization_ruleset delete parameter in rule block has unpredictable result #2725

@yamatt

Description

@yamatt

Describe the need

The github_organization_ruleset resource has a rule block with a delete parameter.

This rule allows you to specify in a Ruleset if a branch can be deleted.

In the UI it looks like this:

Image

The name of the parameter however is delete.

This leads to some confusion, as the UI makes out that the value should be true, but the name of the parameter in Terraform is the opposite.

It is unknown what the effect of setting the parameter to true or false is, or which way it should be. If I make the delete rule true, does that allow or prevent deletions?

This could well be a documentation issue, adding to this the description of the parameter only describes that parameter by what it isn't, rather than what it is.

SDK Version

No response

API Version

No response

Relevant log output

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: TriageThis is being looked at and prioritizedType: DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    ✅ Done

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions