cloudposse/atmos v1.26.0

on GitHub

what

• Update atmos describe affected command
• Add --repo-path flag to atmos describe affected command
• Update docs https://atmos.tools/cli/commands/describe/affected

why

• The --repo-path flag specifies the filesystem path to the already cloned target repository with which to compare the current branch, and it can be used when working with private repositories

Working with Private Repositories

There are a few ways to work with private repositories with which the current local branch is compared to detect the changed files and affected Atmos stacks and components:

• Using the --ssh-key flag to specify the filesystem path to a PEM-encoded private key to clone private repos using SSH, and
  the --ssh-key-password flag to provide the encryption password for the PEM-encoded private key if the key contains a password-encrypted PEM block

• Execute the atmos describe affected command in a GitHub Action, clone the remote target repository in the action, and use the --repo-path flag to specify the path to the already cloned target repository with which to compare the current branch

Using with GitHub Actions

If the atmos describe affected command is executed in a GitHub Action, and you don't want to store or generate a long-lived SSH private key on the server, you can do the following:

• Create a GitHub Personal Access Token (PAT) with scope permissions to clone private repos

• Add the created PAT as a repository or GitHub organization secret with the name GITHUB_TOKEN

• In your GitHub action, clone the remote repository using the checkout GitHub action

• Execute atmos describe affected command with the --repo-path flag set to the cloned repository path using the GITHUB_WORKSPACE ENV variable (which points to the default working directory on the GitHub runner for steps, and the default location of the repository when using the checkout action). For example:

  atmos describe affected --repo-path $GITHUB_WORKSPACE