Skip to content

Commit 5ce97cf

Browse files
okctl-botokctl-bot
committed
docs: Update variable docs
1 parent 19c914a commit 5ce97cf

File tree

3 files changed

+23
-20
lines changed

3 files changed

+23
-20
lines changed

‎determine-stacks/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ Determine which Terraform stacks to run operations on
3939
|`all-dev-stacks` |JSON array of all dev stacks |``${{ steps.stacks.outputs.all-dev-stacks }}`` |
4040
|`all-prod-stacks` |JSON array of all prod stacks |``${{ steps.stacks.outputs.all-prod-stacks }}`` |
4141
|`all-stacks` |JSON array of all stacks (dev and prod combined) |``${{ steps.stacks.outputs.all-stacks }}`` |
42-
|`config` |CI/CD configuration from .gp.cicd.json |``${{ steps.config.outputs.result }}`` |
4342

4443

4544

‎setup-ok/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Setup and install ok and its dependencies
1212

1313
| Input | Description |Required| Default |
1414
|---------------------|-----------------------------------------------------------|--------|-----------|
15-
|`ok_version` |Version of ok to install. Examples: v0.1.0, latest |yes |``v5.13.0``|
16-
|`boilerplate_version`|Version of Boilerplate to install. Examples: 0.5.16, latest|yes |``v0.9.0`` |
17-
|`terraform_version` |Version of Terraform to install. Examples: 1.10.1, latest |yes |``1.12.2`` |
18-
|`terragrunt_version` |Version of Terragrunt to install. Examples: 0.71.1, latest |yes |``v0.84.1``|
19-
|`yq_version` |Version of yq to install. Examples: v4.44.6, latest |yes |``v4.47.1``|
20-
|`tfswitch_version` |Version of tfswitch to install. Examples: v1.4.5, latest |yes |``v1.5.0`` |
15+
|`ok_version` |Version of ok to install. Examples: v0.1.0, latest |yes |``v5.15.3``|
16+
|`boilerplate_version`|Version of Boilerplate to install. Examples: 0.5.16, latest|yes |``v0.10.1``|
17+
|`terraform_version` |Version of Terraform to install. Examples: 1.10.1, latest |yes |``1.14.3`` |
18+
|`terragrunt_version` |Version of Terragrunt to install. Examples: 0.71.1, latest |yes |``v0.96.1``|
19+
|`yq_version` |Version of yq to install. Examples: v4.44.6, latest |yes |``v4.50.1``|
20+
|`tfswitch_version` |Version of tfswitch to install. Examples: v1.4.5, latest |yes |``v1.13.0``|
2121

2222
### Example
2323

‎terraform-deploy/README.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,18 @@ Deploy application through infrastructure
99

1010
### Inputs
1111

12-
| Input | Description | Required | Default |
13-
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------|
14-
| `config` | JSON-encoded config (.gp.cicd.json) | yes | ``n/a`` |
15-
| `stack-dir` | The path to the application stack (e.g., `stacks/dev/app-km`) | yes | ``n/a`` |
16-
| `environment` | The semantic name of the environment (e.g., `dev`, `prod`) | yes | ``n/a`` |
17-
| `tag` | The tag of an artifact to deploy | no | ```` |
18-
| `target-repository` | The name of the repository (e.g., `pirates-iac`) to checkout code from. Leave empty to skip checkout and use the current repository. | no | ``${{ github.event.repository.name }}`` |
19-
| `github-app-id` | ID of GitHub App used to get read access to the repository containing IaC | yes | ``n/a`` |
20-
| `github-app-private-key` | Private key of GitHub App used to get read access to the repository containing IaC | yes | ``n/a`` |
21-
| `github-deploy-key` | Repository deploy key that grants read access to shared libraries (e.g., golden-path-iac) | yes | ``n/a`` |
12+
| Input | Description |Required| Default |
13+
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|
14+
|`config` |JSON-encoded config (.gp.cicd.json) |yes |``n/a`` |
15+
|`stack-dir` |The path to the application stack (e.g., `stacks/dev/app-km`) |yes |``n/a`` |
16+
|`environment` |The type of environment (e.g., `dev`, `prod`). Must match environment in configuration file .gp.cicd.json. |yes |``n/a`` |
17+
|`tag` |The tag of an artifact to deploy |no |```` |
18+
|`target-repository` |The name of the repository (e.g., `pirates-iac`) to checkout code from. Leave empty to skip checkout and use the current repository. |no |``${{ github.event.repository.name }}`` |
19+
|`github-app-id` |ID of GitHub App used to get read access to the repository containing IaC |no |``n/a`` |
20+
|`github-app-private-key`|Private key of GitHub App used to get read access to the repository containing IaC |no |``n/a`` |
21+
|`github-deploy-key` |Repository deploy key that grants read access to shared libraries (e.g., golden-path-iac) |yes |``n/a`` |
22+
|`send-deployment-event` |Whether to send an event to Datadog after successful deployment. By default this is only sent on default branch deployments, and it requires 'tag' to be set.|no |``${{ github.event_name == 'push' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}``|
23+
|`cancel-if-stale` |Whether to cancel the workflow if a newer run has already progressed further than the current run. |no |``true`` |
2224

2325
### Example
2426

@@ -29,11 +31,13 @@ Deploy application through infrastructure
2931
config: # Required
3032
stack-dir: # Required
3133
environment: # Required
32-
# tag: # Optional, default:
34+
# tag: # Optional, default:
3335
# target-repository: # Optional, default: ${{ github.event.repository.name }}
34-
github-app-id: # Required
35-
github-app-private-key: # Required
36+
# github-app-id: # Optional
37+
# github-app-private-key: # Optional
3638
github-deploy-key: # Required
39+
# send-deployment-event: # Optional, default: ${{ github.event_name == 'push' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
40+
# cancel-if-stale: # Optional, default: true
3741
```
3842

3943
## Outputs

0 commit comments

Comments
 (0)