Skip to content

Commit d99f2bd

Browse files
committed
Regenerate docs
1 parent 818ca16 commit d99f2bd

File tree

6 files changed

+131
-0
lines changed

6 files changed

+131
-0
lines changed

tofu-fmt-check/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,39 @@ If any files are not correctly formatted a failing GitHub check will be added fo
2626
- Optional
2727
- Default: `default`
2828

29+
* `variables`
30+
31+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
32+
Variables set here override any given in `var_file`s.
33+
34+
```yaml
35+
with:
36+
variables: |
37+
image_id = "${{ secrets.AMI_ID }}"
38+
availability_zone_names = [
39+
"us-east-1a",
40+
"us-west-1c",
41+
]
42+
```
43+
44+
- Type: string
45+
- Optional
46+
47+
* `var_file`
48+
49+
List of tfvars files to use, one per line.
50+
Paths should be relative to the GitHub Actions workspace
51+
52+
```yaml
53+
with:
54+
var_file: |
55+
common.tfvars
56+
prod.tfvars
57+
```
58+
59+
- Type: string
60+
- Optional
61+
2962
* `backend_config`
3063

3164
List of OpenTofu backend config values, one per line. This is used for discovering the OpenTofu version to use, if the version is not otherwise specified.

tofu-fmt-check/action.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ inputs:
1313
See [dflook/tofu-version](https://github.com/dflook/terraform-github-actions/tree/main/tofu-version#tofu-version-action) for details.
1414
required: false
1515
default: "default"
16+
variables:
17+
description: |
18+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
19+
Variables set here override any given in `var_file`s.
20+
required: false
21+
var_file:
22+
description: |
23+
List of tfvars files to use, one per line.
24+
Paths should be relative to the GitHub Actions workspace
25+
required: false
1626
backend_config:
1727
description: |
1828
List of OpenTofu backend config values, one per line. This is used for discovering the OpenTofu version to use, if the version is not otherwise specified.

tofu-fmt/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,39 @@ This action uses the `tofu fmt -recursive` command to reformat files in a direct
2323
- Optional
2424
- Default: `default`
2525

26+
* `variables`
27+
28+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
29+
Variables set here override any given in `var_file`s.
30+
31+
```yaml
32+
with:
33+
variables: |
34+
image_id = "${{ secrets.AMI_ID }}"
35+
availability_zone_names = [
36+
"us-east-1a",
37+
"us-west-1c",
38+
]
39+
```
40+
41+
- Type: string
42+
- Optional
43+
44+
* `var_file`
45+
46+
List of tfvars files to use, one per line.
47+
Paths should be relative to the GitHub Actions workspace
48+
49+
```yaml
50+
with:
51+
var_file: |
52+
common.tfvars
53+
prod.tfvars
54+
```
55+
56+
- Type: string
57+
- Optional
58+
2659
* `backend_config`
2760

2861
List of OpenTofu backend config values, one per line. This is used for discovering the OpenTofu version to use, if the version is not otherwise specified.

tofu-fmt/action.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ inputs:
1313
See [dflook/tofu-version](https://github.com/dflook/terraform-github-actions/tree/main/tofu-version#tofu-version-action) for details.
1414
required: false
1515
default: "default"
16+
variables:
17+
description: |
18+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
19+
Variables set here override any given in `var_file`s.
20+
required: false
21+
var_file:
22+
description: |
23+
List of tfvars files to use, one per line.
24+
Paths should be relative to the GitHub Actions workspace
25+
required: false
1626
backend_config:
1727
description: |
1828
List of OpenTofu backend config values, one per line. This is used for discovering the OpenTofu version to use, if the version is not otherwise specified.

tofu-output/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,40 @@ Retrieve the root-level outputs from an OpenTofu configuration.
2222
- Optional
2323
- Default: `default`
2424

25+
* `variables`
26+
27+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
28+
29+
Variables set here override any given in `var_file`s.
30+
31+
```yaml
32+
with:
33+
variables: |
34+
image_id = "${{ secrets.AMI_ID }}"
35+
availability_zone_names = [
36+
"us-east-1a",
37+
"us-west-1c",
38+
]
39+
```
40+
41+
- Type: string
42+
- Optional
43+
44+
* `var_file`
45+
46+
List of tfvars files to use, one per line.
47+
Paths should be relative to the GitHub Actions workspace
48+
49+
```yaml
50+
with:
51+
var_file: |
52+
common.tfvars
53+
prod.tfvars
54+
```
55+
56+
- Type: string
57+
- Optional
58+
2559
* `backend_config`
2660

2761
List of OpenTofu backend config values, one per line.

tofu-output/action.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ inputs:
1111
description: OpenTofu workspace to get outputs from
1212
required: false
1313
default: "default"
14+
variables:
15+
description: |
16+
Variables to set when initializing OpenTofu. This should be valid OpenTofu syntax - like a [variable definition file](https://opentofu.org/docs/language/values/variables/#variable-definitions-tfvars-files).
17+
18+
Variables set here override any given in `var_file`s.
19+
required: false
20+
var_file:
21+
description: |
22+
List of tfvars files to use, one per line.
23+
Paths should be relative to the GitHub Actions workspace
24+
required: false
1425
backend_config:
1526
description: List of OpenTofu backend config values, one per line.
1627
required: false

0 commit comments

Comments
 (0)