Skip to main content

GitHub Action: atmos-get-setting

GitHub Action to retreive a setting from atmos configuration.

Introduction

GitHub Action to retreive a setting from atmos configuration.

Usage

# Example stacks/dev.yaml
components:
terraform:
foo:
settings:
secrets-arn: arn:aws:secretsmanager:us-east-1:000000000000:secret:MySecret-PlMes3
vars:
foo: bar
  name: github-action-atmos-get-setting
on:
pull_request:
branches: [ 'main' ]
types: [opened, synchronize, reopened, closed, labeled, unlabeled]

jobs:
context:
runs-on: ubuntu-latest
steps:
- name: github-action-atmos-get-setting
uses: cloudposse/github-action-atmos-get-setting@main
id: example
with:
component: foo
stack: core-ue1-dev
settings-path: secrets-arn

- name: github-action-atmos-get-setting
uses: aws-actions/aws-secretsmanager-get-secrets@v1
with:
secret-ids: ${{ steps.example.outputs.value }}

Inputs

NameDescriptionDefaultRequired
componentThe atmos component extract the settings for.N/Atrue
settings-pathThe settings path using JSONPath expressions.N/Atrue
stackThe atmos stack extract the settings for.N/Atrue

Outputs

NameDescription
valueThe value of the settings