Skip to content

Atmos Affected Stacks Trigger Spacelift

Actions
A GitHub action to trigger the corresponding Spacelift Stack from atmos describe affected
v2.1.0
Latest
Verified creator
Star (3)

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Project Banner

Latest ReleaseSlack Community

GitHub Action for Triggering Affected Spacelift Stacks

Introduction

This repo contains a GitHub Action that determines the affected Atmos 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.

Usage

  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 }}

Inputs

Name Description Default Required
atmos-config-path A path to the folder where atmos.yaml is located . false
atmos-version The version of atmos to install if install-atmos is true latest false
default-branch The default branch to use for the base ref. ${{ github.event.repository.default_branch }} false
deploy A flag to indicate if a deployment should be triggered. If false, a preview will be triggered. false false
github-token A GitHub token for running the spacelift-io/setup-spacectl action N/A true
head-ref The head ref to checkout. If not provided, the head default branch is used. N/A false
install-atmos Whether to install atmos true false
install-jq Whether to install jq false false
install-spacectl Whether to install spacectl true false
jq-force Whether to force the installation of jq true false
jq-version The version of jq to install if install-jq is true 1.6 false
skip-atmos-functions Skip all Atmos functions such as terraform.output in atmos describe affected false false
spacectl-version The version of spacectl to install if install-spacectl is true latest false
spacelift-api-key-id The SPACELIFT_API_KEY_ID N/A false
spacelift-api-key-secret The SPACELIFT_API_KEY_SECRET N/A false
spacelift-endpoint The Spacelift endpoint. For example, https://unicorn.app.spacelift.io N/A false
trigger-method The method to use to trigger the Spacelift stack. Valid values are comment and spacectl comment false

Outputs

Name Description
affected The affected stacks
has-affected-stacks Whether there are affected stacks

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright © 2017-2025 Cloud Posse, LLC

README footer

Beacon

Atmos Affected Stacks Trigger Spacelift is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

A GitHub action to trigger the corresponding Spacelift Stack from atmos describe affected
v2.1.0
Latest

Verified

GitHub has manually verified the creator of the action as an official partner organization. For more info see About badges in GitHub Marketplace.

Atmos Affected Stacks Trigger Spacelift is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.