Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
goruha committed Dec 12, 2023
1 parent 7470aa5 commit 2552d45
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,31 +99,31 @@ components:
settings-path: settings.secrets-arn

- name: Set ENV Vars with AWS Secrets Manager Secret
uses: aws-actions/aws-secretsmanager-get-secrets@v2
uses: aws-actions/aws-secretsmanager-get-secrets@v1
with:
secret-ids: ${{ steps.example.outputs.value }}
```
## Migrating from `v1` to `v2`
## Migrating from `v0` to `v1`

Starting from `v2` the action is no longer restricted to retrieving the component config from only the `settings` section.
If you want the same behavior in `v2` as in`v1`, you should add the `settings.` prefix to the value of the `settings-path` variable.
For example, in `v2` you would provide `settings.secrets-arn` as the value to the `settings-path`
Starting from `v1` the action is no longer restricted to retrieving the component config from only the `settings` section.
If you want the same behavior in `v1` as in`v0`, you should add the `settings.` prefix to the value of the `settings-path` variable.
For example, in `v1` you would provide `settings.secrets-arn` as the value to the `settings-path`
```yaml
- name: Get Atmos Setting for Secret ARN
uses: cloudposse/github-action-atmos-get-setting@v2
uses: cloudposse/github-action-atmos-get-setting@v1
id: example
with:
component: foo
stack: core-ue1-dev
settings-path: settings.secrets-arn
```

Which would provide the same output as passing only `secrets-arn` in `v1`
Which would provide the same output as passing only `secrets-arn` in `v0`

```yaml
- name: Get Atmos Setting for Secret ARN
uses: cloudposse/github-action-atmos-get-setting@v1
uses: cloudposse/github-action-atmos-get-setting@v0
id: example
with:
component: foo
Expand Down
16 changes: 8 additions & 8 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,31 +75,31 @@ usage: |-
settings-path: settings.secrets-arn
- name: Set ENV Vars with AWS Secrets Manager Secret
uses: aws-actions/aws-secretsmanager-get-secrets@v2
uses: aws-actions/aws-secretsmanager-get-secrets@v1
with:
secret-ids: ${{ steps.example.outputs.value }}
```
## Migrating from `v1` to `v2`
## Migrating from `v0` to `v1`
Starting from `v2` the action is no longer restricted to retrieving the component config from only the `settings` section.
If you want the same behavior in `v2` as in`v1`, you should add the `settings.` prefix to the value of the `settings-path` variable.
For example, in `v2` you would provide `settings.secrets-arn` as the value to the `settings-path`
Starting from `v1` the action is no longer restricted to retrieving the component config from only the `settings` section.
If you want the same behavior in `v1` as in`v0`, you should add the `settings.` prefix to the value of the `settings-path` variable.
For example, in `v1` you would provide `settings.secrets-arn` as the value to the `settings-path`
```yaml
- name: Get Atmos Setting for Secret ARN
uses: cloudposse/github-action-atmos-get-setting@v2
uses: cloudposse/github-action-atmos-get-setting@v1
id: example
with:
component: foo
stack: core-ue1-dev
settings-path: settings.secrets-arn
```
Which would provide the same output as passing only `secrets-arn` in `v1`
Which would provide the same output as passing only `secrets-arn` in `v0`
```yaml
- name: Get Atmos Setting for Secret ARN
uses: cloudposse/github-action-atmos-get-setting@v1
uses: cloudposse/github-action-atmos-get-setting@v0
id: example
with:
component: foo
Expand Down

0 comments on commit 2552d45

Please sign in to comment.