Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
goruha committed Dec 14, 2023
1 parent e664f0a commit 631b8d5
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The config should have the following structure:
### Migrating from `v1` to `v2`

- In `v2` variables moved from GitHub Action `inputs` to the Atmos GitOps configuration file, which is by default `./.github/config/atmos-gitops.yaml`
1. `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 |
|--------------------------|
Expand All @@ -143,8 +143,8 @@ The config should have the following structure:
| `aws-region` |
| `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: Determine Affected Stacks
Expand All @@ -154,7 +154,7 @@ If you want the same behavior in `v2` as in`v1` you should create config `./.gi
atmos-gitops-config-path: ./.github/config/atmos-gitops.yaml
```

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

```yaml
- name: Determine Affected Stacks
Expand Down Expand Up @@ -203,7 +203,7 @@ same behaviour as
|------|-------------|
| affected | The affected stacks |
| has-affected-stacks | Whether there are affected stacks |
| matrix | A matrix suitable for use for GitHub Actions of the affected stacks |
| matrix | The affected stacks as matrix structure suitable for extending matrix size workaround (see README) |
<!-- markdownlint-restore -->


Expand Down
8 changes: 4 additions & 4 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ usage: |-
### Migrating from `v1` to `v2`
- In `v2` variables moved from GitHub Action `inputs` to the Atmos GitOps configuration file, which is by default `./.github/config/atmos-gitops.yaml`
1. `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 |
|--------------------------|
Expand All @@ -126,8 +126,8 @@ usage: |-
| `aws-region` |
| `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: Determine Affected Stacks
Expand All @@ -137,7 +137,7 @@ usage: |-
atmos-gitops-config-path: ./.github/config/atmos-gitops.yaml
```
same behaviour as
Which would produce the same behavior as in `v1`, doing this:
```yaml
- name: Determine Affected Stacks
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ outputs:
description: Whether there are affected stacks
value: ${{ steps.matrix.outputs.matrix != '{"include":[]}' }}
matrix:
description: A matrix suitable for use for GitHub Actions of the affected stacks
description: The affected stacks as matrix structure suitable for extending matrix size workaround (see README)
value: ${{ steps.matrix.outputs.matrix }}

runs:
Expand Down
2 changes: 1 addition & 1 deletion docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
|------|-------------|
| affected | The affected stacks |
| has-affected-stacks | Whether there are affected stacks |
| matrix | A matrix suitable for use for GitHub Actions of the affected stacks |
| matrix | The affected stacks as matrix structure suitable for extending matrix size workaround (see README) |
<!-- markdownlint-restore -->

0 comments on commit 631b8d5

Please sign in to comment.