Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/enterprise-organization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This module creates following resources.
## Requirements

| Name | Version |
|------|---------|
| ---- | ------- |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.12 |
| <a name="requirement_github"></a> [github](#requirement\_github) | >= 6.2 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_github"></a> [github](#provider\_github) | 6.9.0 |
| ---- | ------- |
| <a name="provider_github"></a> [github](#provider\_github) | >= 6.2 |

## Modules

Expand All @@ -26,14 +26,14 @@ No modules.
## Resources

| Name | Type |
|------|------|
| ---- | ---- |
| [github_enterprise_organization.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/enterprise_organization) | resource |
| [github_enterprise.this](https://registry.terraform.io/providers/integrations/github/latest/docs/data-sources/enterprise) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| ---- | ----------- | ---- | ------- | :------: |
| <a name="input_billing_email"></a> [billing\_email](#input\_billing\_email) | (Required) The billing email address. | `string` | n/a | yes |
| <a name="input_enterprise"></a> [enterprise](#input\_enterprise) | (Required) The name (slug) of the enterprise. | `string` | n/a | yes |
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the organization. | `string` | n/a | yes |
Expand All @@ -44,7 +44,7 @@ No modules.
## Outputs

| Name | Description |
|------|-------------|
| ---- | ----------- |
| <a name="output_billing_email"></a> [billing\_email](#output\_billing\_email) | The billing email address. |
| <a name="output_database_id"></a> [database\_id](#output\_database\_id) | The database ID of the organization. |
| <a name="output_description"></a> [description](#output\_description) | The description of the organization. |
Expand Down
12 changes: 6 additions & 6 deletions modules/org-organization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ This module creates following resources.
## Requirements

| Name | Version |
|------|---------|
| ---- | ------- |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9 |
| <a name="requirement_github"></a> [github](#requirement\_github) | >= 6.2 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_github"></a> [github](#provider\_github) | 6.2.3 |
| ---- | ------- |
| <a name="provider_github"></a> [github](#provider\_github) | >= 6.2 |

## Modules

Expand All @@ -27,7 +27,7 @@ No modules.
## Resources

| Name | Type |
|------|------|
| ---- | ---- |
| [github_membership.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/membership) | resource |
| [github_organization_block.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_block) | resource |
| [github_organization_security_manager.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_security_manager) | resource |
Expand All @@ -37,7 +37,7 @@ No modules.
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| ---- | ----------- | ---- | ------- | :------: |
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the organization. | `string` | n/a | yes |
| <a name="input_blocked_users"></a> [blocked\_users](#input\_blocked\_users) | (Optional) A list of usernames to block from organization. | `set(string)` | `[]` | no |
| <a name="input_members"></a> [members](#input\_members) | (Optional) A list of usernames to add users as `member` role. When applied, an invitation will be sent to the user to become a member of the organization. | `set(string)` | `[]` | no |
Expand All @@ -47,7 +47,7 @@ No modules.
## Outputs

| Name | Description |
|------|-------------|
| ---- | ----------- |
| <a name="output_blocked_users"></a> [blocked\_users](#output\_blocked\_users) | A list of blocked usernames from organization. |
| <a name="output_description"></a> [description](#output\_description) | The description of the organization. |
| <a name="output_display_name"></a> [display\_name](#output\_display\_name) | The display name of the organization. |
Expand Down
2 changes: 1 addition & 1 deletion modules/org-ruleset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ No modules.

| Name | Description | Type | Default | Required |
| ---- | ----------- | ---- | ------- | :------: |
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the organization ruleset. | `string` | n/a | yes |
| <a name="input_bypass_list"></a> [bypass\_list](#input\_bypass\_list) | (Optional) A list of actors that are allowed to bypass the rules of the ruleset. Each item of `bypass_list` block as defined below.<br/> (Required) `actor` - A configuration for the actor that can bypass the ruleset. `actor` block as defined below.<br/> (Required) `type` - The type of actor that can bypass the ruleset. Can be one of `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`, or `DeployKey`.<br/> (Optional) `id` - The ID of the actor that can bypass the ruleset. When `type` is `OrganizationAdmin`, this should be `1`. For repository roles, use `1` (maintain), `2` (write), `3` (admin), `4` (read), or `5` (triage).<br/> (Optional) `mode` - The mode by which the actor can bypass the ruleset. Can be one of `always` or `pull_request`. Defaults to `always`. | <pre>list(object({<br/> actor = object({<br/> type = string<br/> id = optional(number)<br/> })<br/> mode = optional(string, "always")<br/> }))</pre> | `[]` | no |
| <a name="input_conditions"></a> [conditions](#input\_conditions) | (Optional) A configuration for the conditions that determine which repositories and refs the ruleset applies to. `conditions` block as defined below.<br/> (Optional) `ref_name` - A configuration for matching refs (branches or tags). Required when `target` is `branch` or `tag`. `ref_name` block as defined below.<br/> (Optional) `include` - A list of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts the special values `~ALL` (all refs) and `~DEFAULT_BRANCH` (the default branch).<br/> (Optional) `exclude` - A list of ref names or patterns to exclude. The condition will not pass if any of these patterns match.<br/> (Optional) `repository_name` - A configuration for matching repositories by name. Conflicts with `repository_ids`. `repository_name` block as defined below.<br/> (Optional) `include` - A list of repository names or patterns to include. Also accepts the special value `~ALL`.<br/> (Optional) `exclude` - A list of repository names or patterns to exclude.<br/> (Optional) `protected` - Whether to only include repositories with the default branch protected. Defaults to `false`.<br/> (Optional) `repository_ids` - A list of repository IDs to target. Conflicts with `repository_name`. | <pre>object({<br/> ref_name = optional(object({<br/> include = optional(list(string), [])<br/> exclude = optional(list(string), [])<br/> }), {})<br/> repository_name = optional(object({<br/> include = optional(list(string), [])<br/> exclude = optional(list(string), [])<br/> protected = optional(bool, false)<br/> }))<br/> repository_ids = optional(list(number))<br/> })</pre> | `{}` | no |
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the organization ruleset. | `string` | n/a | yes |
| <a name="input_rules"></a> [rules](#input\_rules) | (Optional) A configuration for the rules enforced by the ruleset. `rules` block as defined below.<br/> (Optional) `creation` - Whether to restrict the creation of matching refs. Defaults to `false`.<br/> (Optional) `update` - Whether to restrict updates to matching refs. Defaults to `false`.<br/> (Optional) `deletion` - Whether to restrict deletion of matching refs. Defaults to `false`.<br/> (Optional) `required_linear_history` - Whether to require a linear commit history, preventing merge commits. Defaults to `false`.<br/> (Optional) `required_signatures` - Whether to require commits pushed to matching refs to have verified signatures. Defaults to `false`.<br/> (Optional) `non_fast_forward` - Whether to block force pushes to matching refs. Defaults to `false`.<br/> (Optional) `pull_request` - A configuration to require a pull request before merging. `pull_request` block as defined below.<br/> (Optional) `dismiss_stale_reviews_on_push` - Whether to dismiss approving reviews when new commits are pushed. Defaults to `false`.<br/> (Optional) `require_code_owner_review` - Whether to require review from code owners. Defaults to `false`.<br/> (Optional) `require_last_push_approval` - Whether the most recent push must be approved by someone other than its author. Defaults to `false`.<br/> (Optional) `required_approving_review_count` - The number of approving reviews required before merging. Defaults to `0`.<br/> (Optional) `required_review_thread_resolution` - Whether all review conversations must be resolved before merging. Defaults to `false`.<br/> (Optional) `required_status_checks` - A configuration to require status checks to pass before merging. `required_status_checks` block as defined below.<br/> (Optional) `checks` - A list of status checks that must pass. Each item of `checks` block as defined below.<br/> (Required) `context` - The name of the required status check.<br/> (Optional) `integration_id` - The ID of the GitHub App that provides the status check. Use `0` for checks not provided by an app.<br/> (Optional) `strict_required_status_checks_policy` - Whether the matching ref must be up to date with the base branch before merging. Defaults to `false`.<br/> (Optional) `required_workflows` - A configuration to require GitHub Actions workflows to pass before merging. `required_workflows` block as defined below.<br/> (Required) `workflows` - A list of workflows that must pass. Each item of `workflows` block as defined below.<br/> (Required) `repository_id` - The ID of the repository where the workflow is defined.<br/> (Required) `path` - The path to the workflow file (e.g., `.github/workflows/scan.yaml`).<br/> (Optional) `ref` - The ref of the workflow file. Defaults to the repository's default branch.<br/> (Optional) `do_not_enforce_on_create` - Whether to skip enforcing the workflows when a matching ref is created. Defaults to `false`.<br/> (Optional) `required_code_scanning` - A configuration to require code scanning results before merging. `required_code_scanning` block as defined below.<br/> (Required) `tools` - A list of code scanning tools that must run. Each item of `tools` block as defined below.<br/> (Required) `tool` - The name of the code scanning tool (e.g., `CodeQL`).<br/> (Required) `alerts_threshold` - The severity level at which code scanning alerts block merging. Can be one of `none`, `errors`, `errors_and_warnings`, or `all`.<br/> (Required) `security_alerts_threshold` - The severity level at which code scanning security alerts block merging. Can be one of `none`, `critical`, `high_or_higher`, `medium_or_higher`, or `all`.<br/> (Optional) `branch_name_pattern` - A configuration to enforce a naming pattern on branches. Only valid when `target` is `branch`. `pattern` block as defined below.<br/> (Optional) `tag_name_pattern` - A configuration to enforce a naming pattern on tags. Only valid when `target` is `tag`. `pattern` block as defined below.<br/> (Optional) `commit_message_pattern` - A configuration to enforce a pattern on commit messages. `pattern` block as defined below.<br/> (Optional) `commit_author_email_pattern` - A configuration to enforce a pattern on commit author emails. `pattern` block as defined below.<br/> (Optional) `committer_email_pattern` - A configuration to enforce a pattern on committer emails. `pattern` block as defined below.<br/> (Required) `operator` - How the pattern is matched. Can be one of `starts_with`, `ends_with`, `contains`, or `regex`.<br/> (Required) `pattern` - The pattern to match against.<br/> (Optional) `name` - A display name for the rule.<br/> (Optional) `negate` - Whether to negate the match (i.e., fail if the pattern matches). Defaults to `false`. | <pre>object({<br/> creation = optional(bool, false)<br/> update = optional(bool, false)<br/> deletion = optional(bool, false)<br/> required_linear_history = optional(bool, false)<br/> required_signatures = optional(bool, false)<br/> non_fast_forward = optional(bool, false)<br/><br/> pull_request = optional(object({<br/> dismiss_stale_reviews_on_push = optional(bool, false)<br/> require_code_owner_review = optional(bool, false)<br/> require_last_push_approval = optional(bool, false)<br/> required_approving_review_count = optional(number, 0)<br/> required_review_thread_resolution = optional(bool, false)<br/> }))<br/><br/> required_status_checks = optional(object({<br/> checks = optional(list(object({<br/> context = string<br/> integration_id = optional(number, 0)<br/> })), [])<br/> strict_required_status_checks_policy = optional(bool, false)<br/> }))<br/><br/> required_workflows = optional(object({<br/> workflows = list(object({<br/> repository_id = number<br/> path = string<br/> ref = optional(string)<br/> }))<br/> do_not_enforce_on_create = optional(bool, false)<br/> }))<br/><br/> required_code_scanning = optional(object({<br/> tools = list(object({<br/> tool = string<br/> alerts_threshold = string<br/> security_alerts_threshold = string<br/> }))<br/> }))<br/><br/> branch_name_pattern = optional(object({<br/> operator = string<br/> pattern = string<br/> name = optional(string)<br/> negate = optional(bool, false)<br/> }))<br/> tag_name_pattern = optional(object({<br/> operator = string<br/> pattern = string<br/> name = optional(string)<br/> negate = optional(bool, false)<br/> }))<br/> commit_message_pattern = optional(object({<br/> operator = string<br/> pattern = string<br/> name = optional(string)<br/> negate = optional(bool, false)<br/> }))<br/> commit_author_email_pattern = optional(object({<br/> operator = string<br/> pattern = string<br/> name = optional(string)<br/> negate = optional(bool, false)<br/> }))<br/> committer_email_pattern = optional(object({<br/> operator = string<br/> pattern = string<br/> name = optional(string)<br/> negate = optional(bool, false)<br/> }))<br/> })</pre> | `{}` | no |
| <a name="input_status"></a> [status](#input\_status) | (Optional) The status (enforcement level) of the ruleset. Can be one of `ACTIVE`, `EVALUATE`, or `DISABLED`. Use `EVALUATE` to monitor (dry-run) which actions would be blocked without actually blocking them. Defaults to `ACTIVE`. | `string` | `"ACTIVE"` | no |
| <a name="input_target"></a> [target](#input\_target) | (Optional) The target of the ruleset. Can be one of `branch`, `tag`, or `push`. Defaults to `branch`. | `string` | `"branch"` | no |
Expand Down
12 changes: 6 additions & 6 deletions modules/org-team/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ This module creates following resources.
## Requirements

| Name | Version |
|------|---------|
| ---- | ------- |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9 |
| <a name="requirement_github"></a> [github](#requirement\_github) | >= 6.11 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_github"></a> [github](#provider\_github) | 6.11.0 |
| ---- | ------- |
| <a name="provider_github"></a> [github](#provider\_github) | >= 6.11 |

## Modules

Expand All @@ -29,7 +29,7 @@ No modules.
## Resources

| Name | Type |
|------|------|
| ---- | ---- |
| [github_team.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/team) | resource |
| [github_team_members.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/team_members) | resource |
| [github_team_membership.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/team_membership) | resource |
Expand All @@ -40,7 +40,7 @@ No modules.
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| ---- | ----------- | ---- | ------- | :------: |
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the team. | `string` | n/a | yes |
| <a name="input_code_review_auto_assignment"></a> [code\_review\_auto\_assignment](#input\_code\_review\_auto\_assignment) | (Optional) A configuration for code review auto assignment. `code_review_auto_assignment` block as defined below.<br/> (Optional) `enabled` - Whether to enable code review auto assignment. Defaults to `false`.<br/> (Optional) `algorithm` - The algorithm to use for code review auto assignment. Valid values are `ROUND_ROBIN` or `LOAD_BALANCE`. Defaults to `ROUND_ROBIN`.<br/> (Optional) `assignment_count` - The number of reviewers to assign for each pull request.<br/> (Optional) `notify_team_enabled` - Whether to notify the entire team when both a team and one or more of its members are requested for review. Defaults to `false`. | <pre>object({<br/> enabled = optional(bool, false)<br/> algorithm = optional(string, "ROUND_ROBIN")<br/> assignment_count = optional(number)<br/><br/> notify_team_enabled = optional(bool, false)<br/> })</pre> | `{}` | no |
| <a name="input_description"></a> [description](#input\_description) | (Optional) A description of the team. | `string` | `"Managed by Terraform."` | no |
Expand All @@ -56,7 +56,7 @@ No modules.
## Outputs

| Name | Description |
|------|-------------|
| ---- | ----------- |
| <a name="output_code_review_auto_assignment"></a> [code\_review\_auto\_assignment](#output\_code\_review\_auto\_assignment) | A configuration for code review auto assignment. |
| <a name="output_description"></a> [description](#output\_description) | The description of the team. |
| <a name="output_id"></a> [id](#output\_id) | The ID of the team. |
Expand Down
Loading