Skip to content

Commit 1f7cfbb

Browse files
committed
build: generate documentation readme and vars (#29)
1 parent 7110630 commit 1f7cfbb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,11 @@ module "main_with_key" {
5757
name = "repository-example-with-key"
5858
description = "github repository for repository"
5959
visibility = "public"
60-
key = "/usr/etc/key/user.pub"
61-
read_only = false
60+
deploy_keys = [{
61+
title = "user key"
62+
key = "/usr/etc/key/user.pub"
63+
read_only = false
64+
}]
6265
}
6366
6467
module "main_with_secrets" {
@@ -107,11 +110,10 @@ This document gives an overview of variables used in the platform of the terrafo
107110
| Name | Description | Type | Default | Required |
108111
| --- | --- | --- | --- | :-: |
109112
| default_branch | Name of the Default Branch of the Repository | `string` | `"develop"` | no |
113+
| deploy_keys | The name of repositories. | <pre>list(object({<br> title = string<br> key = string<br> read_only = bool<br> }))</pre> | `[]` | no |
110114
| description | The description of the repository. | `string` | n/a | yes |
111-
| key | filename pub for repository deploy key. | `string` | `null` | no |
112115
| name | The name of the repository. | `string` | n/a | yes |
113116
| pages | Configuratin block for GitHub Pages | <pre>map(object({<br> branch = string<br> path = string<br> cname = string<br> }))</pre> | `{}` | no |
114-
| read_only | enabled read_only or no. | `bool` | `true` | no |
115117
| secrets | secrets for repository | `map(any)` | `{}` | no |
116118
| settings | Create and manage settings. | <pre>map(object({<br> homepage_url = string<br> has_issues = bool<br> has_projects = bool<br> has_wiki = bool<br> is_template = bool<br> allow_merge_commit = bool<br> allow_squash_merge = bool<br> allow_rebase_merge = bool<br> delete_branch_on_merge = bool<br> auto_init = bool<br> gitignore_template = string<br> license_template = string<br> archived = bool<br> archive_on_destroy = bool<br> vulnerability_alerts = bool<br> topics = list(string)<br> }))</pre> | `{}` | no |
117119
| visibility | The visibility of the repository private or public. | `string` | `"private"` | no |

docs/include/terraform.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,10 @@ This document gives an overview of variables used in the platform of the terrafo
2323
| Name | Description | Type | Default | Required |
2424
| --- | --- | --- | --- | :-: |
2525
| default_branch | Name of the Default Branch of the Repository | `string` | `"develop"` | no |
26+
| deploy_keys | The name of repositories. | <pre>list(object({<br> title = string<br> key = string<br> read_only = bool<br> }))</pre> | `[]` | no |
2627
| description | The description of the repository. | `string` | n/a | yes |
27-
| key | filename pub for repository deploy key. | `string` | `null` | no |
2828
| name | The name of the repository. | `string` | n/a | yes |
2929
| pages | Configuratin block for GitHub Pages | <pre>map(object({<br> branch = string<br> path = string<br> cname = string<br> }))</pre> | `{}` | no |
30-
| read_only | enabled read_only or no. | `bool` | `true` | no |
3130
| secrets | secrets for repository | `map(any)` | `{}` | no |
3231
| settings | Create and manage settings. | <pre>map(object({<br> homepage_url = string<br> has_issues = bool<br> has_projects = bool<br> has_wiki = bool<br> is_template = bool<br> allow_merge_commit = bool<br> allow_squash_merge = bool<br> allow_rebase_merge = bool<br> delete_branch_on_merge = bool<br> auto_init = bool<br> gitignore_template = string<br> license_template = string<br> archived = bool<br> archive_on_destroy = bool<br> vulnerability_alerts = bool<br> topics = list(string)<br> }))</pre> | `{}` | no |
3332
| visibility | The visibility of the repository private or public. | `string` | `"private"` | no |

0 commit comments

Comments
 (0)