Skip to content

Commit

Permalink
readme and descriptions updated
Browse files Browse the repository at this point in the history
  • Loading branch information
milldr committed Jun 20, 2023
1 parent 9e56e1a commit 68ffd46
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,12 @@ this action. For more on setting up those components, see the `gitops` component
| aws-region | AWS region for assuming identity. | us-east-1 | false |
| component | The name of the component to plan. | N/A | true |
| component-path | The path to the base component. Atmos defines this value as component\_path. | N/A | true |
| log-level | Log level for this action. Default 'INFO' | INFO | false |
| stack | The stack name for the given component. | N/A | true |
| terraform-plan-role | The AWS role to be used to plan Terraform. | N/A | true |
| terraform-state-bucket | The S3 Bucket where the planfiles are stored. | N/A | true |
| terraform-state-role | The AWS role to be used to retrieve the planfile from AWS. | N/A | true |
| terraform-state-table | The DynamoDB table where planfile metadata is stored. | N/A | true |
| terraform\_version | The version of Terraform CLI to install. Instead of full version string you can also specify constraint string starting with "<" (for example `<1.13.0`) to install the latest version satisfying the constraint. A value of `latest` will install the latest version of Terraform CLI. Defaults to `latest`. | latest | false |


<!-- markdownlint-restore -->
Expand Down
9 changes: 6 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,23 @@ inputs:
description: "Atmos version to use for vendoring. Default 'latest'"
required: false
default: 'latest'
log-level:
description: "Log level for this action. Default 'INFO'"
terraform_version:
description: 'The version of Terraform CLI to install. Instead of full version string you can also specify constraint string starting with "<" (for example `<1.13.0`) to install the latest version satisfying the constraint. A value of `latest` will install the latest version of Terraform CLI. Defaults to `latest`.'
default: 'latest'
required: false
default: 'INFO'

runs:
using: "composite"
steps:
- uses: actions/checkout@v3

- uses: hashicorp/setup-terraform@v2
with:
terraform_version: ${{ inputs.terraform_version }}

- uses: cloudposse/[email protected]
with:
version: ${{ inputs.atmos-version }}
install-wrapper: false

- name: Filter Atmos Settings Value
Expand Down
2 changes: 1 addition & 1 deletion docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
| aws-region | AWS region for assuming identity. | us-east-1 | false |
| component | The name of the component to plan. | N/A | true |
| component-path | The path to the base component. Atmos defines this value as component\_path. | N/A | true |
| log-level | Log level for this action. Default 'INFO' | INFO | false |
| stack | The stack name for the given component. | N/A | true |
| terraform-plan-role | The AWS role to be used to plan Terraform. | N/A | true |
| terraform-state-bucket | The S3 Bucket where the planfiles are stored. | N/A | true |
| terraform-state-role | The AWS role to be used to retrieve the planfile from AWS. | N/A | true |
| terraform-state-table | The DynamoDB table where planfile metadata is stored. | N/A | true |
| terraform\_version | The version of Terraform CLI to install. Instead of full version string you can also specify constraint string starting with "<" (for example `<1.13.0`) to install the latest version satisfying the constraint. A value of `latest` will install the latest version of Terraform CLI. Defaults to `latest`. | latest | false |


<!-- markdownlint-restore -->

0 comments on commit 68ffd46

Please sign in to comment.