README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: github-action-atmos-affected-trigger-spacelift
# Tags of this project
tags:
  - github-action
  - atmos
  - spacelift

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/github-action-atmos-affected-trigger-spacelift

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/github-action-atmos-affected-trigger-spacelift.svg"
    url: "https://github.com/cloudposse/github-action-atmos-affected-trigger-spacelift/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related: []

# Short description of this project
description: GitHub Action for Triggering Affected Spacelift Stacks

introduction: |-
  This repo contains a GitHub Action that determines the affected [Atmos](https://atmos.tools) stacks for a PR, then
  creates a comment on the PR which Spacelift can use to trigger the corresponding stacks via a push policy.

  Optionally, you can use the `spacectl` trigger method, which uses the `spacectl` CLI to trigger the corresponding
  spacelift stacks directly rather than via comment/push policy.

references:
  - name: "github-actions-workflows"
    description: "Reusable workflows for different types of projects"
    url: "https://github.com/cloudposse/github-actions-workflows"
  - name: "example-github-action-release-workflow"
    description: "Example application with complicated release workflow"
    url: "https://github.com/cloudposse/example-github-action-release-workflow"

# How to use this project
usage: |-
  ```yaml
    name: Pull Request
    on:
      pull_request:
        branches: [ 'main' ]
        types: [opened, synchronize, reopened, closed, labeled, unlabeled]

    jobs:
      context:
        runs-on: ubuntu-latest
        steps:
          - name: Atmos Affected Stacks Trigger Spacelift (via comment)
            uses: cloudposse/github-action-atmos-affected-trigger-spacelift@main
            id: example
            with:
              atmos-config-path: ./rootfs/usr/local/etc/atmos
              github-token: ${{ secrets.GITHUB_TOKEN }}

          - name: Atmos Affected Stacks Trigger Spacelift (direct)
            uses: cloudposse/github-action-atmos-affected-trigger-spacelift@main
            id: example
            with:
              atmos-config-path: ./rootfs/usr/local/etc/atmos
              github-token: ${{ secrets.GITHUB_TOKEN }}
              trigger-method: spacectl
              spacelift-endpoint: https://unicorn.app.spacelift.io
              spacelift-api-key-id: ${{ secrets.SPACELIFT_API_KEY_ID }}
              spacelift-api-key-secret: ${{ secrets.SPACELIFT_API_KEY_SECRET }}

  ```

include:
  - "docs/github-action.md"

# Contributors to this project
contributors:
  - name: "Matt Calhoun"
    github: "mcalhoun"