Skip to content

Commit 905dc1c

Browse files
committed
update docs
1 parent f9a8cc2 commit 905dc1c

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

modules/organization_settings/README.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,44 @@ No modules.
2626

2727
| Name | Type |
2828
|------|------|
29-
| [github_actions_organization_permissions.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/actions_organization_permissions) | resource |
29+
| [github_organization_settings.this](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/organization_settings) | resource |
3030

3131
## Inputs
3232

3333
| Name | Description | Type | Default | Required |
3434
|------|-------------|------|---------|:--------:|
35-
| allows_public_repositories | Whether public repositories can be added to the runner group | `bool` | `null` | no |
36-
| name | Name of the runner group | `string` | n/a | yes |
37-
| restricted_to_workflows | If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false. | `bool` | `null` | no |
38-
| selected_repository_ids | IDs of the repositories which should be added to the runner group | `list(string)` | `[]` | no |
39-
| selected_workflows | List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true. | `list(string)` | `[]` | no |
40-
| visibility | Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API. | `string` | `null` | no |
35+
| advanced_security_enabled_for_new_repositories | Whether or not advanced security is enabled for new repositories. Defaults to false. | `bool` | `null` | no |
36+
| billing_email | The billing email address for the organization. | `string` | n/a | yes |
37+
| blog | The blog URL for the organization. | `string` | `null` | no |
38+
| company | The company name for the organization. | `string` | `null` | no |
39+
| default_repository_permission | The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read. | `string` | `null` | no |
40+
| dependabot_alerts_enabled_for_new_repositories | Whether or not dependabot alerts are enabled for new repositories. Defaults to false. | `bool` | `null` | no |
41+
| dependabot_security_updates_enabled_for_new_repositories | Whether or not dependabot security updates are enabled for new repositories. Defaults to false. | `bool` | `null` | no |
42+
| dependency_graph_enabled_for_new_repositories | Whether or not dependency graph is enabled for new repositories. Defaults to false. | `bool` | `null` | no |
43+
| description | The description for the organization. | `string` | `null` | no |
44+
| email | The email address for the organization. | `string` | `null` | no |
45+
| has_organization_projects | Whether or not organization projects are enabled for the organization. | `bool` | `null` | no |
46+
| has_repository_projects | Whether or not repository projects are enabled for the organization. | `bool` | `null` | no |
47+
| location | The location for the organization. | `string` | `null` | no |
48+
| members_can_create_internal_repositories | Whether or not organization members can create new internal repositories. For Enterprise Organizations only. | `bool` | `null` | no |
49+
| members_can_create_pages | Whether or not organization members can create new pages. Defaults to true. | `bool` | `null` | no |
50+
| members_can_create_private_pages | Whether or not organization members can create new private pages. Defaults to true. | `bool` | `null` | no |
51+
| members_can_create_private_repositories | Whether or not organization members can create new private repositories. Defaults to true. | `bool` | `null` | no |
52+
| members_can_create_public_pages | Whether or not organization members can create new public pages. Defaults to true. | `bool` | `null` | no |
53+
| members_can_create_public_repositories | Whether or not organization members can create new public repositories. Defaults to true. | `bool` | `null` | no |
54+
| members_can_create_repositories | Whether or not organization members can create new repositories. Defaults to true. | `bool` | `null` | no |
55+
| members_can_fork_private_repositories | Whether or not organization members can fork private repositories. Defaults to false. | `bool` | `null` | no |
56+
| name | The name for the organization. | `string` | `null` | no |
57+
| secret_scanning_enabled_for_new_repositories | Whether or not secret scanning is enabled for new repositories. Defaults to false. | `bool` | `null` | no |
58+
| secret_scanning_push_protection_enabled_for_new_repositories | Whether or not secret scanning push protection is enabled for new repositories. Defaults to false. | `bool` | `null` | no |
59+
| twitter_username | The Twitter username for the organization. | `string` | `null` | no |
60+
| web_commit_signoff_required | Whether or not commit signatures are required for commits to the organization. Defaults to false. | `bool` | `null` | no |
4161

4262
## Outputs
4363

4464
| Name | Description |
4565
|------|-------------|
46-
| test | test |
66+
| id | The ID of the organization settings. |
4767

4868

4969
## Contributing

0 commit comments

Comments
 (0)