GitHub Action: atmos-component-updater

This is GitHub Action that can be used as a workflow for automatic updates via Pull Requests in your infrastructure repository according to versions in components sources.

Introduction

This is GitHub Action that can be used as a workflow for automatic updates via Pull Requests in your infrastructure repository according to versions in components sources.

Key Features:

• Selective Component Processing: Configure the action to exclude or include specific components using wildcards, ensuring that only relevant updates are processed.
• PR Management: Limit the number of PRs opened at a time, making it easier to manage large-scale updates without overwhelming the system. Automatically close old component-update PRs, so they don't pile up.
• Material Changes Focus: Automatically open pull requests only for components with significant changes, skipping minor updates to component.yaml files to reduce unnecessary PRs and maintain a streamlined system.
• Informative PRs: Link PRs to release notes for new components, providing easy access to relevant information, and use consistent naming for easy tracking.
• Scheduled Updates: Run the action on a cron schedule tailored to your organization's needs, ensuring regular and efficient updates.

Usage

Prerequisites

This GitHub Action once used in workflow needs permissions to create/update branches and open/close pull requests so the access token needs to be passed.

It can be done in two ways:

• create a dedicated Personal Access Token (PAT)
• use GITHUB_TOKEN

If you would like to use GITHUB_TOKEN make sure to set permissions in the workflow as follow:

permissions:
  contents: write
  pull-requests: write

Also, make sure that you set to Allow GitHub Actions to create and approve pull requests on both organization and repository levels:

• https://github.com/organizations/YOUR-ORG/settings/actions
• https://github.com/YOUR-ORG/YOUR-REPO/settings/actions

Workflow example

  name: "atmos-components"

  on:
    workflow_dispatch: {}

    schedule:
      - cron:  '0 8 * * 1'         # Execute every week on Monday at 08:00

  permissions:
    contents: write
    pull-requests: write

  jobs:
    update:
      runs-on: ubuntu-latest
      steps:
        - name: Checkout
          uses: actions/checkout@v3
          with:
            fetch-depth: 0

        - name: Update Atmos Components
          uses: cloudposse/github-action-atmos-component-updater@v2
          with:
            github-access-token: ${{ secrets.GITHUB_TOKEN }}
            max-number-of-prs: 5
            include: |
              aws-*
              eks/*
              bastion
            exclude: aws-sso,aws-saml

Using a Custom Atmos CLI Config Path (atmos.yaml)

If your atmos.yaml file is not located in the root of the infrastructure repository, you can specify the path to it using ATMOS_CLI_CONFIG_PATH env variable.

  # ...
  - name: Update Atmos Components
    uses: cloudposse/github-action-atmos-component-updater@v2
    env:
      # Directory containing the `atmos.yaml` file
      ATMOS_CLI_CONFIG_PATH: ${{ github.workspace }}/rootfs/usr/local/etc/atmos/
    with:
      github-access-token: ${{ secrets.GITHUB_TOKEN }}
      max-number-of-prs: 5

Customize Pull Request labels, title and body

  # ...
  - name: Update Atmos Components
    uses: cloudposse/github-action-atmos-component-updater@v2
    with:
      github-access-token: ${{ secrets.GITHUB_TOKEN }}
      max-number-of-prs: 5
      pr-title: 'Update Atmos Component \`{{ component_name }}\` to {{ new_version }}'
      pr-body: |
        ## what
        Component \`{{ component_name }}\` was updated [{{ old_version }}]({{ old_version_link }}) → [{{ old_version }}]({{ old_version_link }}).

        ## references
        - [{{ source_name }}]({{ source_link }})
      pr-labels: |
        component-update
        automated
        atmos

IMPORTANT: The backtick symbols must be escaped in the GitHub Action parameters. This is because GitHub evaluates whatever is in the backticks and it will render as an empty string.

For title template these placeholders are available:

• component_name
• source_name
• old_version
• new_version

For body template these placeholders are available:

• component_name
• source_name
• source_link
• old_version
• new_version
• old_version_link
• new_version_link
• old_component_release_link
• new_component_release_link

FAQ

The action cannot find any components

You may see that the action returns zero components:

[06-03-2024 17:53:47] INFO    Found 0 components
[]

This is a common error when the workflow has not checked out the repository before calling this action. Add the following before calling this action.

- name: Checkout
  uses: actions/checkout@v4

The action cannot find the component.yaml file

You may see the action fail to find the component.yaml file for a given component as such:

FileNotFoundError: [Errno 2] No such file or directory: 'components/terraform/account-map/component.yaml'

This is likely related to a missing or invalid atmos.yaml configuration file. Set ATMOS_CLI_CONFIG_PATH to the path to your Atmos configuration file.

env:
  ATMOS_CLI_CONFIG_PATH: ${{ github.workspace }}/rootfs/usr/local/etc/atmos/

The action does not have permission to create Pull Requests

Your action may fail with the following message:

github.GithubException.GithubException: 403 {"message": "GitHub Actions is not permitted to create or approve pull requests.", "documentation_url": "https://docs.github.com/rest/pulls/pulls#create-a-pull-request"}

In order to create Pull Requests in your repository, we need to set the permissions for the workflow:

permissions:
  contents: write
  pull-requests: write

And you need to allow GitHub Actions to create and approve pulls requests in both the GitHub Organization and Repository:

1. https://github.com/organizations/YOUR-ORG/settings/actions > Allow GitHub Actions to create and approve pull requests
2. https://github.com/YOUR-ORG/YOUR-REPO/settings/actions > Allow GitHub Actions to create and approve pull requests