Skip to content

Commit 5c22e1f

Browse files
committed
build: generate documentation readme and vars (#27)
1 parent 398d855 commit 5c22e1f

File tree

2 files changed

+59
-25
lines changed

2 files changed

+59
-25
lines changed

README.md

Lines changed: 57 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Terraform module to provision an github repository.
2222

2323
This project is part of our comprehensive [hadenlabs](https://hadenlabs.com) modules of terraform.
2424

25+
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
26+
2527
## Usage
2628

2729
```hcl
@@ -36,41 +38,46 @@ This project is part of our comprehensive [hadenlabs](https://hadenlabs.com) mod
3638
name = "repository-example"
3739
description = "github repository for repository"
3840
visibility = "public"
39-
41+
settings = {
42+
auto_init = true
43+
has_issues = true
44+
has_wiki = true
45+
has_projects = true
4046
}
47+
}
4148
42-
module "main_with_key" {
43-
source = "hadenlabs/repository/github"
44-
version = "0.4.0"
49+
module "main_with_key" {
50+
source = "hadenlabs/repository/github"
51+
version = "0.4.0"
4552
46-
providers = {
47-
github = github
48-
}
49-
50-
name = "repository-example-with-key"
51-
description = "github repository for repository"
52-
visibility = "public"
53-
key = "/usr/etc/key/user.pub"
54-
read_only = false
53+
providers = {
54+
github = github
5555
}
5656
57-
module "main_with_secrets" {
58-
source = "hadenlabs/repository/github"
59-
version = "0.4.0"
57+
name = "repository-example-with-key"
58+
description = "github repository for repository"
59+
visibility = "public"
60+
key = "/usr/etc/key/user.pub"
61+
read_only = false
62+
}
6063
61-
providers = {
62-
github = github
63-
}
64+
module "main_with_secrets" {
65+
source = "hadenlabs/repository/github"
66+
version = "0.4.0"
6467
65-
name = "repository-example-with-key"
66-
description = "github repository for repository"
67-
visibility = "public"
68-
secrets = {
69-
key= value
70-
}
68+
providers = {
69+
github = github
70+
}
7171
72+
name = "repository-example-with-key"
73+
description = "github repository for repository"
74+
visibility = "public"
75+
secrets = {
76+
key= value
7277
}
7378
79+
}
80+
7481
```
7582

7683
Full working example can be found in [example](./example) folder.
@@ -87,6 +94,7 @@ This document gives an overview of variables used in the platform of the terrafo
8794
| --------- | ------- |
8895
| terraform | >= 0.13 |
8996
| github | >=4.3.0 |
97+
| local | >=1.3.0 |
9098

9199
## Providers
92100

@@ -105,6 +113,7 @@ This document gives an overview of variables used in the platform of the terrafo
105113
| pages | Configuratin block for GitHub Pages | <pre>map(object({<br> branch = string<br> path = string<br> cname = string<br> }))</pre> | `{}` | no |
106114
| read_only | enabled read_only or no. | `bool` | `true` | no |
107115
| secrets | secrets for repository | `map(any)` | `{}` | no |
116+
| 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 |
108117
| visibility | The visibility of the repository private or public. | `string` | `"private"` | no |
109118

110119
## Outputs
@@ -149,6 +158,29 @@ Releases are managed using github release feature. We use \[Semantic Versioning\
149158

150159
Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)
151160

161+
## License
162+
163+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
164+
165+
See [LICENSE](LICENSE) for full details.
166+
167+
Licensed to the Apache Software Foundation (ASF) under one
168+
or more contributor license agreements. See the NOTICE file
169+
distributed with this work for additional information
170+
regarding copyright ownership. The ASF licenses this file
171+
to you under the Apache License, Version 2.0 (the
172+
"License"); you may not use this file except in compliance
173+
with the License. You may obtain a copy of the License at
174+
175+
https://www.apache.org/licenses/LICENSE-2.0
176+
177+
Unless required by applicable law or agreed to in writing,
178+
software distributed under the License is distributed on an
179+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
180+
KIND, either express or implied. See the License for the
181+
specific language governing permissions and limitations
182+
under the License.
183+
152184
## Trademarks
153185

154186
All other trademarks referenced herein are the property of their respective owners.

docs/include/terraform.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This document gives an overview of variables used in the platform of the terrafo
1010
| --------- | ------- |
1111
| terraform | >= 0.13 |
1212
| github | >=4.3.0 |
13+
| local | >=1.3.0 |
1314

1415
## Providers
1516

@@ -28,6 +29,7 @@ This document gives an overview of variables used in the platform of the terrafo
2829
| pages | Configuratin block for GitHub Pages | <pre>map(object({<br> branch = string<br> path = string<br> cname = string<br> }))</pre> | `{}` | no |
2930
| read_only | enabled read_only or no. | `bool` | `true` | no |
3031
| secrets | secrets for repository | `map(any)` | `{}` | no |
32+
| 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 |
3133
| visibility | The visibility of the repository private or public. | `string` | `"private"` | no |
3234

3335
## Outputs

0 commit comments

Comments
 (0)