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]>
  • Loading branch information
goruha and osterman authored Dec 14, 2023
1 parent fa50260 commit 18e0fd7
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ references:
usage: |
### Config
The action expects the atmos gitops configuration file to be present in the repository in `./.github/config/atmos-gitops.yaml`.
The config should have the following structure:
The action expects the Atmos GitOps configuration file to be present in the repository in `./.github/config/atmos-gitops.yaml`.
The config supports the following settings:
```yaml
atmos-version: 1.45.3
Expand All @@ -83,7 +84,8 @@ usage: |
sort-by: .stack_slug
group-by: .stack_slug | split("-") | [.[0], .[2]] | join("-")
```
[!IMPORTANT]
>**Please note!** the `terraform-state-*` parameters refer to the S3 Bucket and corresponding meta storage DynamoDB table used to store the Terraform Plan files, and not the "Terraform State". These parameters will be renamed in a subsequent release.
### GitHub Actions Workflow Example
In following GitHub workflow example first job will filter components that have settings `github.actions_enabled: true` and then in following job `stack_slug` will be printed to stdout.
Expand Down Expand Up @@ -118,8 +120,8 @@ usage: |
```
### Migrating from `v0` to `v1`
`v1` replace `jq-query` input with `selected-filter` variable and simplify the query.
The major changes between versions `v0` and `v1` are as follows:
- `v1` replaced the `jq-query` input parameter with a new parameter called `selected-filter` to simplify the query for end-users.
Now you need to specify only part used in select function of `jq-query`.
`v1` moved variables from `inputs` to atmos gitops config path `./.github/config/atmos-gitops.yaml`
Expand Down Expand Up @@ -154,7 +156,7 @@ usage: |
jq-query: 'to_entries[] | .key as $parent | .value.components.terraform | to_entries[] | select(.value.settings.github.actions_enabled // false) | [$parent, .key] | join(",")'
```
Please note that the atmos-gitops-config-path is not the same file as as the atmos-config-path.
Please note that the `atmos-gitops-config-path` is not the same file as the `atmos-config-path`.
include:
Expand Down

0 comments on commit 18e0fd7

Please sign in to comment.