Catosplace GitHub Ruleset Module

TODO: Write description here!!!

Providers

Name	Version
github	~> 6.11.1

Requirements

Name	Version
github	~> 6.11.1

Example

module "default_branch_ruleset" {

  source = "../.."

  repository_rulesets = {
    "default_branch_ruleset" = {
      repository_name = "TODO_REPOSITORY"
      target          = "branch"
      enforcement     = "active"
      conditions = {
        ref_name = {}
      }
    }
  }
}

Inputs

Name	Description	Type	Default	Required
repository_rulesets	A map of repository ruleset configurations	map(object({ repository_name = string target = string enforcement = string conditions = optional(object({ ref_name = object({ include = optional(list(string), []) exclude = optional(list(string), []) }) })) bypass_actors = optional(object({ actor_id = optional(number) actor_type = string bypass_mode = optional(string) })) }))	{}	no

Outputs

No outputs.

Terraform Docs

This repository uses terraform-docs to generate module documentation. We use a custom .terraform-docs.yml configuration to include a header from main.tf, an examples section and a footer from docs/footer.md.

To regenerate the documentation use the basic terraform-docs command.

terraform-docs .

ADRs

This repository uses Architecture Decision Records (ADRs) to document important technical and architectural decisions.

• ADR index: docs/adr/index.md
• New ADRs should be created with adr
• After creating or updating ADRs, regenerate the index