Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Dan Miller <[email protected]>
  • Loading branch information
3 people authored Dec 12, 2023
1 parent 3b68c33 commit 0c0dd8b
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ usage: |-
to allow GitHub to assume roles in AWS and then deploying both a Terraform Apply role and a Terraform State role.
For Cloud Posse documentation on setting up GitHub OIDC, see our [`github-oidc-provider` component](https://docs.cloudposse.com/components/library/aws/github-oidc-provider/).
In order to retrieve Terraform State, we configure an S3 Bucket to store plan files and a DynamoDB table to track plan metadata. Both will need to be deployed before running
this action. For more on setting up those components, see the `gitops` component (__documentation pending__). This action will then use the [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) action to update these resources.
In order to retrieve Terraform Plan Files (not to be confused with Terraform State files, e.g. `tfstate`), we configure an S3 Bucket to store plan files and a DynamoDB table to track plan metadata. Both need to be deployed before running
this action. For more on setting up those components, see the [`gitops` component](https://docs.cloudposse.com/components/library/aws/gitops/). This action will then use the [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) action to update these resources.
### Config
Expand Down Expand Up @@ -104,10 +104,8 @@ usage: |-
### Migrating from `v1` to `v2`
`v2` drop `component-path` variable. Now it fetches from `atmos.yaml` file automatically.
`v2` moved variables from `inputs` to atmos gitops config path `./.github/config/atmos-gitops.yaml`
1. `v2` drops the `component-path` variable and instead fetches if directly from the [`atmos.yaml` file](https://atmos.tools/cli/configuration/) automatically. Simply remove the `component-path` argument from your invocations of the `cloudposse/github-action-atmos-terraform-apply` action.
2. `v2` moves most of the `inputs` to the Atmos GitOps config path `./.github/config/atmos-gitops.yaml`. Simply create this file, transfer your settings to it, then remove the corresponding arguments from your invocations of the `cloudposse/github-action-atmos-terraform-apply` action.
| name |
|--------------------------|
| `atmos-version` |
Expand All @@ -122,7 +120,7 @@ usage: |-
| `enable-infracost` |


If you want the same behavior in `v2` as in`v1` you should create config `./.github/config/atmos-gitops.yaml` with the same variables as in `v1` inputs.
If you want the same behavior in `v2` as in `v1` you should create config `./.github/config/atmos-gitops.yaml` with the same variables as in `v1` inputs.

```yaml
- name: Terraform apply
Expand All @@ -133,7 +131,7 @@ usage: |-
stack: "plat-ue2-sandbox"
```

same behaviour as
Which would produce the same behavior as in `v1`, doing this:

```yaml
- name: Terraform apply
Expand Down

0 comments on commit 0c0dd8b

Please sign in to comment.