From 2a4e1dc6540d934f1534045a7e159f1c6b6a1a8d Mon Sep 17 00:00:00 2001 From: Byungjin Park Date: Mon, 14 Sep 2026 16:10:43 +0900 Subject: [PATCH] docs: regenerate terraform-docs with shared config Regenerate module documentation with terraform-docs v0.24.0 using the shared .terraform-docs.yml (lockfile: false, sort by required), so README.md matches the output checked by the Terraform integration CI. --- modules/enterprise-organization/README.md | 12 ++++++------ modules/org-organization/README.md | 12 ++++++------ modules/org-ruleset/README.md | 2 +- modules/org-team/README.md | 12 ++++++------ modules/project/README.md | 12 ++++++------ modules/repository-custom-property/README.md | 12 ++++++------ modules/repository-environment/README.md | 12 ++++++------ modules/repository/README.md | 14 +++++++------- modules/webhook/README.md | 16 ++++++++-------- 9 files changed, 52 insertions(+), 52 deletions(-) diff --git a/modules/enterprise-organization/README.md b/modules/enterprise-organization/README.md index ad1c47e..6335992 100644 --- a/modules/enterprise-organization/README.md +++ b/modules/enterprise-organization/README.md @@ -9,15 +9,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.12 | | [github](#requirement\_github) | >= 6.2 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.9.0 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.2 | ## Modules @@ -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 | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [billing\_email](#input\_billing\_email) | (Required) The billing email address. | `string` | n/a | yes | | [enterprise](#input\_enterprise) | (Required) The name (slug) of the enterprise. | `string` | n/a | yes | | [name](#input\_name) | (Required) The name of the organization. | `string` | n/a | yes | @@ -44,7 +44,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [billing\_email](#output\_billing\_email) | The billing email address. | | [database\_id](#output\_database\_id) | The database ID of the organization. | | [description](#output\_description) | The description of the organization. | diff --git a/modules/org-organization/README.md b/modules/org-organization/README.md index 21b57c3..b3221c4 100644 --- a/modules/org-organization/README.md +++ b/modules/org-organization/README.md @@ -10,15 +10,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.9 | | [github](#requirement\_github) | >= 6.2 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.2.3 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.2 | ## Modules @@ -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 | @@ -37,7 +37,7 @@ No modules. ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) The name of the organization. | `string` | n/a | yes | | [blocked\_users](#input\_blocked\_users) | (Optional) A list of usernames to block from organization. | `set(string)` | `[]` | no | | [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 | @@ -47,7 +47,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [blocked\_users](#output\_blocked\_users) | A list of blocked usernames from organization. | | [description](#output\_description) | The description of the organization. | | [display\_name](#output\_display\_name) | The display name of the organization. | diff --git a/modules/org-ruleset/README.md b/modules/org-ruleset/README.md index 6fa8f08..b9d83ad 100644 --- a/modules/org-ruleset/README.md +++ b/modules/org-ruleset/README.md @@ -32,9 +32,9 @@ No modules. | Name | Description | Type | Default | Required | | ---- | ----------- | ---- | ------- | :------: | +| [name](#input\_name) | (Required) The name of the organization ruleset. | `string` | n/a | yes | | [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.
(Required) `actor` - A configuration for the actor that can bypass the ruleset. `actor` block as defined below.
(Required) `type` - The type of actor that can bypass the ruleset. Can be one of `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`, or `DeployKey`.
(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).
(Optional) `mode` - The mode by which the actor can bypass the ruleset. Can be one of `always` or `pull_request`. Defaults to `always`. | 
list(object({
    actor = object({
      type = string
      id   = optional(number)
    })
    mode = optional(string, "always")
  }))
| `[]` | no | | [conditions](#input\_conditions) | (Optional) A configuration for the conditions that determine which repositories and refs the ruleset applies to. `conditions` block as defined below.
(Optional) `ref_name` - A configuration for matching refs (branches or tags). Required when `target` is `branch` or `tag`. `ref_name` block as defined below.
(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).
(Optional) `exclude` - A list of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
(Optional) `repository_name` - A configuration for matching repositories by name. Conflicts with `repository_ids`. `repository_name` block as defined below.
(Optional) `include` - A list of repository names or patterns to include. Also accepts the special value `~ALL`.
(Optional) `exclude` - A list of repository names or patterns to exclude.
(Optional) `protected` - Whether to only include repositories with the default branch protected. Defaults to `false`.
(Optional) `repository_ids` - A list of repository IDs to target. Conflicts with `repository_name`. | 
object({
    ref_name = optional(object({
      include = optional(list(string), [])
      exclude = optional(list(string), [])
    }), {})
    repository_name = optional(object({
      include   = optional(list(string), [])
      exclude   = optional(list(string), [])
      protected = optional(bool, false)
    }))
    repository_ids = optional(list(number))
  })
| `{}` | no | -| [name](#input\_name) | (Required) The name of the organization ruleset. | `string` | n/a | yes | | [rules](#input\_rules) | (Optional) A configuration for the rules enforced by the ruleset. `rules` block as defined below.
(Optional) `creation` - Whether to restrict the creation of matching refs. Defaults to `false`.
(Optional) `update` - Whether to restrict updates to matching refs. Defaults to `false`.
(Optional) `deletion` - Whether to restrict deletion of matching refs. Defaults to `false`.
(Optional) `required_linear_history` - Whether to require a linear commit history, preventing merge commits. Defaults to `false`.
(Optional) `required_signatures` - Whether to require commits pushed to matching refs to have verified signatures. Defaults to `false`.
(Optional) `non_fast_forward` - Whether to block force pushes to matching refs. Defaults to `false`.
(Optional) `pull_request` - A configuration to require a pull request before merging. `pull_request` block as defined below.
(Optional) `dismiss_stale_reviews_on_push` - Whether to dismiss approving reviews when new commits are pushed. Defaults to `false`.
(Optional) `require_code_owner_review` - Whether to require review from code owners. Defaults to `false`.
(Optional) `require_last_push_approval` - Whether the most recent push must be approved by someone other than its author. Defaults to `false`.
(Optional) `required_approving_review_count` - The number of approving reviews required before merging. Defaults to `0`.
(Optional) `required_review_thread_resolution` - Whether all review conversations must be resolved before merging. Defaults to `false`.
(Optional) `required_status_checks` - A configuration to require status checks to pass before merging. `required_status_checks` block as defined below.
(Optional) `checks` - A list of status checks that must pass. Each item of `checks` block as defined below.
(Required) `context` - The name of the required status check.
(Optional) `integration_id` - The ID of the GitHub App that provides the status check. Use `0` for checks not provided by an app.
(Optional) `strict_required_status_checks_policy` - Whether the matching ref must be up to date with the base branch before merging. Defaults to `false`.
(Optional) `required_workflows` - A configuration to require GitHub Actions workflows to pass before merging. `required_workflows` block as defined below.
(Required) `workflows` - A list of workflows that must pass. Each item of `workflows` block as defined below.
(Required) `repository_id` - The ID of the repository where the workflow is defined.
(Required) `path` - The path to the workflow file (e.g., `.github/workflows/scan.yaml`).
(Optional) `ref` - The ref of the workflow file. Defaults to the repository's default branch.
(Optional) `do_not_enforce_on_create` - Whether to skip enforcing the workflows when a matching ref is created. Defaults to `false`.
(Optional) `required_code_scanning` - A configuration to require code scanning results before merging. `required_code_scanning` block as defined below.
(Required) `tools` - A list of code scanning tools that must run. Each item of `tools` block as defined below.
(Required) `tool` - The name of the code scanning tool (e.g., `CodeQL`).
(Required) `alerts_threshold` - The severity level at which code scanning alerts block merging. Can be one of `none`, `errors`, `errors_and_warnings`, or `all`.
(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`.
(Optional) `branch_name_pattern` - A configuration to enforce a naming pattern on branches. Only valid when `target` is `branch`. `pattern` block as defined below.
(Optional) `tag_name_pattern` - A configuration to enforce a naming pattern on tags. Only valid when `target` is `tag`. `pattern` block as defined below.
(Optional) `commit_message_pattern` - A configuration to enforce a pattern on commit messages. `pattern` block as defined below.
(Optional) `commit_author_email_pattern` - A configuration to enforce a pattern on commit author emails. `pattern` block as defined below.
(Optional) `committer_email_pattern` - A configuration to enforce a pattern on committer emails. `pattern` block as defined below.
(Required) `operator` - How the pattern is matched. Can be one of `starts_with`, `ends_with`, `contains`, or `regex`.
(Required) `pattern` - The pattern to match against.
(Optional) `name` - A display name for the rule.
(Optional) `negate` - Whether to negate the match (i.e., fail if the pattern matches). Defaults to `false`. | 
object({
    creation                = optional(bool, false)
    update                  = optional(bool, false)
    deletion                = optional(bool, false)
    required_linear_history = optional(bool, false)
    required_signatures     = optional(bool, false)
    non_fast_forward        = optional(bool, false)

    pull_request = optional(object({
      dismiss_stale_reviews_on_push     = optional(bool, false)
      require_code_owner_review         = optional(bool, false)
      require_last_push_approval        = optional(bool, false)
      required_approving_review_count   = optional(number, 0)
      required_review_thread_resolution = optional(bool, false)
    }))

    required_status_checks = optional(object({
      checks = optional(list(object({
        context        = string
        integration_id = optional(number, 0)
      })), [])
      strict_required_status_checks_policy = optional(bool, false)
    }))

    required_workflows = optional(object({
      workflows = list(object({
        repository_id = number
        path          = string
        ref           = optional(string)
      }))
      do_not_enforce_on_create = optional(bool, false)
    }))

    required_code_scanning = optional(object({
      tools = list(object({
        tool                      = string
        alerts_threshold          = string
        security_alerts_threshold = string
      }))
    }))

    branch_name_pattern = optional(object({
      operator = string
      pattern  = string
      name     = optional(string)
      negate   = optional(bool, false)
    }))
    tag_name_pattern = optional(object({
      operator = string
      pattern  = string
      name     = optional(string)
      negate   = optional(bool, false)
    }))
    commit_message_pattern = optional(object({
      operator = string
      pattern  = string
      name     = optional(string)
      negate   = optional(bool, false)
    }))
    commit_author_email_pattern = optional(object({
      operator = string
      pattern  = string
      name     = optional(string)
      negate   = optional(bool, false)
    }))
    committer_email_pattern = optional(object({
      operator = string
      pattern  = string
      name     = optional(string)
      negate   = optional(bool, false)
    }))
  })
| `{}` | no | | [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 | | [target](#input\_target) | (Optional) The target of the ruleset. Can be one of `branch`, `tag`, or `push`. Defaults to `branch`. | `string` | `"branch"` | no | diff --git a/modules/org-team/README.md b/modules/org-team/README.md index a61cae1..189dfc6 100644 --- a/modules/org-team/README.md +++ b/modules/org-team/README.md @@ -12,15 +12,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.9 | | [github](#requirement\_github) | >= 6.11 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.11.0 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.11 | ## Modules @@ -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 | @@ -40,7 +40,7 @@ No modules. ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) The name of the team. | `string` | n/a | yes | | [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.
(Optional) `enabled` - Whether to enable code review auto assignment. Defaults to `false`.
(Optional) `algorithm` - The algorithm to use for code review auto assignment. Valid values are `ROUND_ROBIN` or `LOAD_BALANCE`. Defaults to `ROUND_ROBIN`.
(Optional) `assignment_count` - The number of reviewers to assign for each pull request.
(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`. | 
object({
    enabled          = optional(bool, false)
    algorithm        = optional(string, "ROUND_ROBIN")
    assignment_count = optional(number)

    notify_team_enabled = optional(bool, false)
  })
| `{}` | no | | [description](#input\_description) | (Optional) A description of the team. | `string` | `"Managed by Terraform."` | no | @@ -56,7 +56,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [code\_review\_auto\_assignment](#output\_code\_review\_auto\_assignment) | A configuration for code review auto assignment. | | [description](#output\_description) | The description of the team. | | [id](#output\_id) | The ID of the team. | diff --git a/modules/project/README.md b/modules/project/README.md index 11dac47..9f85892 100644 --- a/modules/project/README.md +++ b/modules/project/README.md @@ -10,15 +10,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.9 | | [github](#requirement\_github) | >= 6.2 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.2.2 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.2 | ## Modules @@ -27,7 +27,7 @@ No modules. ## Resources | Name | Type | -|------|------| +| ---- | ---- | | [github_organization_project.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_project) | resource | | [github_project_column.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/project_column) | resource | | [github_repository_project.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_project) | resource | @@ -35,7 +35,7 @@ No modules. ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) The name of the project. | `string` | n/a | yes | | [columns](#input\_columns) | (Optional) A list of columns for the project. | `set(string)` | `[]` | no | | [description](#input\_description) | (Optional) A description of the project. | `string` | `"Managed by Terraform."` | no | @@ -45,7 +45,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [columns](#output\_columns) | A list of columns of the project. | | [description](#output\_description) | The description of the team. | | [id](#output\_id) | The ID of the project. | diff --git a/modules/repository-custom-property/README.md b/modules/repository-custom-property/README.md index b6a79a6..2042c04 100644 --- a/modules/repository-custom-property/README.md +++ b/modules/repository-custom-property/README.md @@ -8,15 +8,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.12 | | [github](#requirement\_github) | >= 6.11 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.11.1 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.11 | ## Modules @@ -25,13 +25,13 @@ No modules. ## Resources | Name | Type | -|------|------| +| ---- | ---- | | [github_organization_custom_properties.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_custom_properties) | resource | ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) The name of the custom property. | `string` | n/a | yes | | [allowed\_values](#input\_allowed\_values) | (Optional) A set of allowed values for the custom property. This is required if the `type` is `SINGLE_SELECT` or `MULTI_SELECT`. | `set(string)` | `[]` | no | | [default](#input\_default) | (Optional) The default value of the custom property. | `any` | `null` | no | @@ -43,7 +43,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [allowed\_values](#output\_allowed\_values) | A set of allowed values for the custom property. | | [default](#output\_default) | The default value of the custom property. | | [description](#output\_description) | The description of the custom property. | diff --git a/modules/repository-environment/README.md b/modules/repository-environment/README.md index 78ebbbf..a74cca1 100644 --- a/modules/repository-environment/README.md +++ b/modules/repository-environment/README.md @@ -11,15 +11,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.12 | | [github](#requirement\_github) | >= 6.11 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.11.1 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.11 | ## Modules @@ -28,7 +28,7 @@ No modules. ## Resources | Name | Type | -|------|------| +| ---- | ---- | | [github_actions_environment_secret.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/actions_environment_secret) | resource | | [github_actions_environment_variable.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/actions_environment_variable) | resource | | [github_repository_environment.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_environment) | resource | @@ -40,7 +40,7 @@ No modules. ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) The name of the environment. | `string` | n/a | yes | | [repository](#input\_repository) | (Required) The repository name which the environment belongs to. | `string` | n/a | yes | | [allow\_admin\_to\_bypass](#input\_allow\_admin\_to\_bypass) | (Optional) Whether to allow admins to bypass the wait timer and deployment review. The default value is `true`. | `bool` | `true` | no | @@ -54,7 +54,7 @@ No modules. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [allow\_admin\_to\_bypass](#output\_allow\_admin\_to\_bypass) | Whether to allow admins to bypass the wait timer and deployment review. | | [allow\_self\_approval](#output\_allow\_self\_approval) | Whether to allow users to approve their own deployment. | | [deployment\_policy](#output\_deployment\_policy) | The configuration for deployment policy of the environment. | diff --git a/modules/repository/README.md b/modules/repository/README.md index 4c1ce48..7f64c41 100644 --- a/modules/repository/README.md +++ b/modules/repository/README.md @@ -19,26 +19,26 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.9 | | [github](#requirement\_github) | >= 6.2 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.11.1 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.2 | ## Modules | Name | Source | Version | -|------|--------|---------| +| ---- | ------ | ------- | | [environment](#module\_environment) | ../repository-environment | n/a | ## Resources | Name | Type | -|------|------| +| ---- | ---- | | [github_branch.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch) | resource | | [github_branch_default.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch_default) | resource | | [github_issue_label.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/issue_label) | resource | @@ -56,7 +56,7 @@ This module creates following resources. ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [name](#input\_name) | (Required) A name of the repository. | `string` | n/a | yes | | [access](#input\_access) | (Optional) A configuration for the repository access. `access` block as defined below.
(Optional) `collaborators` - A list of collaborators to the repository. Each item of `collaborators` block as defined below.
(Required) `username` - The GitHub username to add to the repository as a collaborator.
(Optional) `role` - The role to grant the collaborator in the repository. Valid values are `read`, `triage`, `write`, `maintain`, `admin` or the name of an existing custom repository role within the organisation. Default is `write`.
(Optional) `teams` - A list of teams to the repository. Each item of `teams` block as defined below.
(Required) `team` - The GitHub team id or the GitHub team slug.
(Optional) `role` - The role to grant the team in the repository. Valid values are `read`, `triage`, `write`, `maintain`, `admin` or the name of an existing custom repository role within the organisation. Default is `read`.
(Optional) `sync_enabled` - Whether to sync the repository access. Accesses added outside of the Terraform code will be removed. Defaults to `false`. | 
object({
    collaborators = optional(list(object({
      username = string
      role     = optional(string, "write")
    })), [])
    teams = optional(list(object({
      team = string
      role = optional(string, "read")
    })), [])
    sync_enabled = optional(bool, false)
  })
| `{}` | no | | [archive\_on\_destroy](#input\_archive\_on\_destroy) | (Optional) Whether to archive the repository instead of deleting on destroy. Defaults to `false`. | `bool` | `false` | no | @@ -82,7 +82,7 @@ This module creates following resources. ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [access](#output\_access) | The configuration for the repository access. | | [archived](#output\_archived) | Whether the repository is archived. | | [autolink\_references](#output\_autolink\_references) | A list of autolink references for the repository. | diff --git a/modules/webhook/README.md b/modules/webhook/README.md index 6d81865..7e9ffbc 100644 --- a/modules/webhook/README.md +++ b/modules/webhook/README.md @@ -9,15 +9,15 @@ This module creates following resources. ## Requirements | Name | Version | -|------|---------| +| ---- | ------- | | [terraform](#requirement\_terraform) | >= 1.9 | | [github](#requirement\_github) | >= 6.2 | ## Providers | Name | Version | -|------|---------| -| [github](#provider\_github) | 6.2.2 | +| ---- | ------- | +| [github](#provider\_github) | >= 6.2 | ## Modules @@ -26,26 +26,26 @@ No modules. ## Resources | Name | Type | -|------|------| +| ---- | ---- | | [github_organization_webhook.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_webhook) | resource | | [github_repository_webhook.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_webhook) | resource | ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| +| ---- | ----------- | ---- | ------- | :------: | | [url](#input\_url) | (Required) The URL of the webhook. | `string` | n/a | yes | | [content\_type](#input\_content\_type) | (Optional) The content type for the webhook payload. Valid values are either `FORM` or `JSON`. | `string` | `"JSON"` | no | | [enabled](#input\_enabled) | (Optional) Whether to activate the webhook should receive events. | `bool` | `true` | no | -| [events](#input\_events) | (Optional) A list of events which should trigger the webhook. Default is for only `push` event. | `set(string)` | 
[
  "push"
]
| no | -| [repositories](#input\_repositories) | (Optional) A list of repositories to create the webhook for. Create an organization-level webhook if you provide `*`. | `set(string)` | 
[
  "*"
]
| no | +| [events](#input\_events) | (Optional) A list of events which should trigger the webhook. Default is for only `push` event. | `set(string)` | 
[
  "push"
]
| no | +| [repositories](#input\_repositories) | (Optional) A list of repositories to create the webhook for. Create an organization-level webhook if you provide `*`. | `set(string)` | 
[
  "*"
]
| no | | [secret](#input\_secret) | (Optional) The shared secret for the webhook. | `string` | `""` | no | | [ssl\_enabled](#input\_ssl\_enabled) | (Optional) Whether to verify SSL certificates when delivering payloads. Default is true. | `bool` | `true` | no | ## Outputs | Name | Description | -|------|-------------| +| ---- | ----------- | | [content\_type](#output\_content\_type) | The content type of the webhook payload. | | [enabled](#output\_enabled) | Whether the webhook is enabled. | | [events](#output\_events) | A list of events which trigger the webhook. |