Skip to main content

GitHub Action: atmos-terraform-select-components

GitHub Action that outputs list of Atmos components by jq query

Introduction

GitHub Action that outputs list of Atmos components by jq query.

For example following query will fetch components that have in settings set github.actions_enabled: true:

.value.settings.github.actions_enabled // false

Output of this action is a list of basic component information. For example:

[
{
"stack": "plat-ue2-sandbox",
"component": "test-component-01",
"stack_slug": "plat-ue2-sandbox-test-component-01",
"component_path": "components/terraform/s3-bucket"
}
]

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:

  atmos-version: 1.45.3
atmos-config-path: ./rootfs/usr/local/etc/atmos/
terraform-state-bucket: cptest-core-ue2-auto-gitops
terraform-state-table: cptest-core-ue2-auto-gitops
terraform-state-role: arn:aws:iam::xxxxxxxxxxxx:role/cptest-core-ue2-auto-gitops-gha
terraform-plan-role: arn:aws:iam::yyyyyyyyyyyy:role/cptest-core-gbl-identity-gitops
terraform-apply-role: arn:aws:iam::yyyyyyyyyyyy:role/cptest-core-gbl-identity-gitops
terraform-version: 1.5.2
aws-region: us-east-2
enable-infracost: false
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.

  jobs:
selected-components:
runs-on: ubuntu-latest
name: github-action-atmos-terraform-select-components
outputs:
matrix: ${{ steps.components.outputs.matrix }}
steps:
- name: github-action-atmos-terraform-select-components
id: components
uses: cloudposse/github-action-atmos-terraform-select-components@v0
with:
atmos-config-path: "${{ github.workspace }}/rootfs/usr/local/etc/atmos/"
jq-query: 'to_entries[] | .key as $parent | .value.components.terraform | to_entries[] | select(.value.settings.github.actions_enabled // false) | [$parent, .key] | join(",")'

print-stack-slug:
runs-on: ubuntu-latest
needs:
- selected-components
if: ${{ needs.selected-components.outputs.matrix != '{"include":[]}' }}
strategy:
matrix: ${{ fromJson(needs.selected-components.outputs.matrix) }}
name: github-action-atmos-terraform-select-components
steps:
- name: github-action-atmos-terraform-select-components
run:
echo "${{ matrix.stack_slug }}"

Migrating from v0 to v1

  1. v1 replaces 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 the part used inside of the select(...) function of the jq-query.

2.v1 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-select-components action.

name
atmos-version
atmos-config-path

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 v0 inputs.

  - name: github-action-atmos-terraform-select-components
id: components
uses: cloudposse/github-action-atmos-terraform-select-components@v1
with:
atmos-gitops-config-path: ./.github/config/atmos-gitops.yaml
select-filter: '.settings.github.actions_enabled // false'

Which would produce the same behavior as in v2, doing this:

  - name: github-action-atmos-terraform-select-components
id: components
uses: cloudposse/github-action-atmos-terraform-select-components@v0
with:
atmos-config-path: "${{ github.workspace }}/rootfs/usr/local/etc/atmos/"
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 the atmos-config-path.