Skip to content
This repository was archived by the owner on Dec 21, 2024. It is now read-only.

Commit 84cd359

Browse files
lasuillardlasuillard
authored
Update examples (#26)
1 parent 39ed164 commit 84cd359

26 files changed

+433
-116
lines changed

‎.github/workflows/ci.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ jobs:
1616
steps:
1717
- uses: actions/checkout@v4
1818
- uses: hashicorp/setup-terraform@v3
19+
20+
- name: Validate Terraform modules recursively
21+
run: ./scripts/tf-validate.sh
22+
1923
- uses: jaxxstorm/action-install-gh-release@v1.12.0
2024
with:
2125
repo: terraform-docs/terraform-docs

‎.vscode/settings.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
{
22
"editor.formatOnSave": true,
3-
"json.format.enable": true
3+
"json.format.enable": true,
4+
"cSpell.words": [
5+
"rulesets"
6+
]
47
}

‎README.md

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

‎examples/authoritative/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# authoritative
2+
3+
Configuration example for creating public GitHub repository.
4+
5+
<!-- BEGIN_TF_DOCS -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.0 |
11+
| <a name="requirement_github"></a> [github](#requirement\_github) | ~> 6.2 |
12+
13+
## Providers
14+
15+
No providers.
16+
17+
## Modules
18+
19+
| Name | Source | Version |
20+
|------|--------|---------|
21+
| <a name="module_authoritative"></a> [authoritative](#module\_authoritative) | ../../ | n/a |
22+
23+
## Resources
24+
25+
No resources.
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_github_token"></a> [github\_token](#input\_github\_token) | n/a | `string` | n/a | yes |
32+
33+
## Outputs
34+
35+
| Name | Description |
36+
|------|-------------|
37+
| <a name="output_this"></a> [this](#output\_this) | n/a |
38+
<!-- END_TF_DOCS -->

‎examples/authoritative/main.tf

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
provider "github" {
2+
token = var.github_token
3+
}
4+
5+
module "authoritative" {
6+
source = "../../"
7+
8+
name = "authoritative"
9+
10+
collaborators = {
11+
authoritative = {
12+
users = [
13+
{
14+
username = "some-username"
15+
}
16+
],
17+
teams = [
18+
{
19+
team_id = "some-team-id"
20+
}
21+
]
22+
}
23+
}
24+
collaborators_authoritative = true
25+
26+
issue_labels = [
27+
{
28+
name = "Urgent"
29+
color = "#FF0000"
30+
description = "Something urgent"
31+
}
32+
]
33+
issue_labels_authoritative = true
34+
}

‎examples/authoritative/outputs.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
output "this" {
2+
value = module.authoritative
3+
}

‎examples/authoritative/variables.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
variable "github_token" {
2+
type = string
3+
}

‎examples/authoritative/versions.tf

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
terraform {
2+
required_version = "~> 1.0"
3+
4+
required_providers {
5+
github = {
6+
source = "integrations/github"
7+
version = "~> 6.2"
8+
}
9+
}
10+
}

‎examples/complete-disabled/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# complete-disabled
2+
3+
Configuration example for creating public GitHub repository.
4+
5+
<!-- BEGIN_TF_DOCS -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.0 |
11+
| <a name="requirement_github"></a> [github](#requirement\_github) | ~> 6.2 |
12+
13+
## Providers
14+
15+
No providers.
16+
17+
## Modules
18+
19+
| Name | Source | Version |
20+
|------|--------|---------|
21+
| <a name="module_disabled"></a> [disabled](#module\_disabled) | ../complete | n/a |
22+
23+
## Resources
24+
25+
No resources.
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_github_token"></a> [github\_token](#input\_github\_token) | n/a | `string` | n/a | yes |
32+
33+
## Outputs
34+
35+
| Name | Description |
36+
|------|-------------|
37+
| <a name="output_this"></a> [this](#output\_this) | n/a |
38+
<!-- END_TF_DOCS -->

‎examples/complete-disabled/main.tf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module "disabled" {
2+
source = "../complete"
3+
4+
github_token = var.github_token
5+
create = false
6+
}

‎examples/complete-disabled/outputs.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
output "this" {
2+
value = module.disabled
3+
}

‎examples/complete-disabled/variables.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
variable "github_token" {
2+
type = string
3+
}

‎examples/complete-disabled/versions.tf

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
terraform {
2+
required_version = "~> 1.0"
3+
4+
required_providers {
5+
github = {
6+
source = "integrations/github"
7+
version = "~> 6.2"
8+
}
9+
}
10+
}

‎examples/complete/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@ No providers.
1818

1919
| Name | Source | Version |
2020
|------|--------|---------|
21-
| <a name="module_authoritatve"></a> [authoritatve](#module\_authoritatve) | ../../ | n/a |
2221
| <a name="module_complete"></a> [complete](#module\_complete) | ../../ | n/a |
23-
| <a name="module_disabled"></a> [disabled](#module\_disabled) | ../../ | n/a |
24-
| <a name="module_simple"></a> [simple](#module\_simple) | ../../ | n/a |
2522

2623
## Resources
2724

@@ -31,9 +28,12 @@ No resources.
3128

3229
| Name | Description | Type | Default | Required |
3330
|------|-------------|------|---------|:--------:|
31+
| <a name="input_create"></a> [create](#input\_create) | n/a | `bool` | `true` | no |
3432
| <a name="input_github_token"></a> [github\_token](#input\_github\_token) | n/a | `string` | n/a | yes |
3533

3634
## Outputs
3735

38-
No outputs.
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_this"></a> [this](#output\_this) | n/a |
3939
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)