github-actions-workflows-terraform-module

Workflows for managing a terraform module repo

Tip

👽 Use Atmos with Terraform

ITisOpen uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Introduction

Use provided GitHub Actions reusable workflows to implement consistent release workflow for terraform modules

Workflows

Name	Description
Feature Branch (Pull Request) ChatOps for a Terraform Module	### Usage
Feature Branch (Pull Request) Workflow of a Terraform Module	### Usage
Release Branch Workflow of a Terraform Module	### Usage
Release Published Workflow of a Terraform Module	### Usage
Scheduled Workflows of a Terraform Module	### Usage

Feature Branch (Pull Request) ChatOps for a Terraform Module

Usage

In your repo create .github/workflows/feature-branch-chatops.yml

  name: feature-branch-chatops
  on:
    issue_comment:
      types: [created]
  
  permissions:
    pull-requests: write
    id-token: write
    contents: read
  
  jobs:
    terraform-module:
      uses: itisopen/github-actions-workflows-terraform-module/.github/workflows/feature-branch-chatops.yml@itisopen
      secrets:
        github_access_token: ${{ secrets.REPO_ACCESS_TOKEN }}

Inputs

Name	Description	Type	Default	Required
runs-on	Overrides job runs-on setting (json-encoded list)	string	["ubuntu-latest"]	false

Secrets

Name	Description	Required
github_access_token	GitHub API token	true

Feature Branch (Pull Request) Workflow of a Terraform Module

Usage

In your repo create .github/workflows/feature-branch.yml

  name: feature-branch
  on:
    pull_request:
      branches: [ main ]
      types: [opened, synchronize, reopened, labeled, unlabeled]
  
  permissions:
    pull-requests: write
    id-token: write
    contents: read
  
  jobs:
    terraform-module:
      uses: itisopen/github-actions-workflows-terraform-module/.github/workflows/feature-branch.yml@itisopen
      secrets:
        github_access_token: ${{ secrets.REPO_ACCESS_TOKEN }}

Inputs

Name	Description	Type	Default	Required
runs-on	Overrides job runs-on setting (json-encoded list)	string	["ubuntu-latest"]	false

Secrets

Name	Description	Required
REPO_ACCESS_TOKEN	GitHub API token	false

Release Branch Workflow of a Terraform Module

Usage

In your repo create .github/workflows/release-branch.yml

  name: release-branch
  on:
    push:
      branches:
        - main
        - release/**
  
  permissions:
    contents: write
    id-token: write
  
  jobs:
    terraform-module:
      uses: itisopen/github-actions-workflows-terraform-module/.github/workflows/release-branch.yml@itisopen
      secrets:
        github_access_token: ${{ secrets.REPO_ACCESS_TOKEN }}

Inputs

Name	Description	Type	Default	Required
runs-on	Overrides job runs-on setting (json-encoded list)	string	["ubuntu-latest"]	false

Secrets

Name	Description	Required
REPO_ACCESS_TOKEN	GitHub API token	true

Release Published Workflow of a Terraform Module

Usage

In your repo create .github/workflows/release.yml

  name: release
  on:
    release:
      types:
        - published
  
  permissions:
    contents: write
    id-token: write
  
  jobs:
    terraform-module:
      uses: itisopen/github-actions-workflows-terraform-module/.github/workflows/release-published.yml@itisopen

Inputs

Name	Description	Type	Default	Required
runs-on	Overrides job runs-on setting (json-encoded list)	string	["ubuntu-latest"]	false

Scheduled Workflows of a Terraform Module

Usage

In your repo create .github/workflows/scheduled.yml

  name: scheduled
  on:
    schedule:
      - cron: "0 3 * * *"

  permissions:
    pull-requests: write
    id-token: write
    contents: write
  
  jobs:
    scheduled:
      uses: itisopen/github-actions-workflows-terraform-module/.github/workflows/scheduled.yml@itisopen
      secrets:
        REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}

Inputs

Name	Description	Type	Default	Required
runs-on	Overrides job runs-on setting (json-encoded list)	string	["ubuntu-latest"]	false

Secrets

Name	Description	Required
REPO_ACCESS_TOKEN	GitHub API token	true

Related Projects

Check out these related projects.

• github-actions-workflows - Reusable workflows for different types of projects

References

For additional context, refer to some of these links.

• terraform-example-module - Example application for CI/CD demonstrations of GitHub Actions deal with Docker, ECR, EKS and Helmfile

Tip

Use Terraform Reference Architectures for AWS, Azure, Oracle Cloud, GCP, Hetzner, and more!

Use ITisOpen's ready-to-go terraform architecture blueprints to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source.

📚 Learn More

ITisOpen is a community backed project providing solutions for startups and enterprises. We build on top of the excellent work of ITisOpen's open source tools such as Atmos and their Terraform modules and components to help you get started quickly. ITisOpen is a leader in the open source community and has been building production-ready infrastructure for over 5 years. But they focus exclusively on AWS. In this community we extend their work and make it available for other cloud providers like Azure, Oracle Cloud, GCP, and Hetzner.

Your team can operate like a pro today.

Ensure that your team succeeds by using ITisOpen's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

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

• Many thanks to the outstanding contributors to the Cloud Posse upstream contents. We appreciate your hard work and dedication to building scalable enterprise grade solutions.
• Many thanks also to the contributors to the ITisOpen upstream contents. We appreciate your hard work and dedication to extending the work of Cloud Posse to other cloud providers.

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 "ITisOpen" 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 open infrastructure.

Note: ITisOpen is leverages open-source projects from Cloud Posse. We encourage you to also join the Cloud Posse Slack community for even more collaboration and support: slack.cloudposse.com

📰 Newsletter

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

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, all rights reserved for upstream content.
• Copyright © 2025-2025 ITisOpen, all rights reserved for repository's specific content