cloudposse/github-action-preview-environment-controller

Action to manage to deploy and purge preview environments depends on PR labels

Introduction

Testing Pull Request changes usually lead to having it deployed on a preview environment. The environment can be ephemeral or pre-provisioned. In the last case, there is a countable number of preview environments. This GitHub Action follows a pattern when the developer set PR label to specify a preview environment to deploy. github-action-preview-environment-controller allow to define map of environment => label. Depending on current PR labels the action outputs a list of deploy and destroy environments. So it performs a controller role and does not limit deployment methods or tools.

Usage

Use github-action-preview-environment-controller in Pull Request triggered pipeline, and use it's outputs to determinate what environments should be deployed and what cleaned up.

  name: Pull Request
  on:
    pull_request:
      branches: [ 'main' ]
      types: [opened, synchronize, reopened, closed, labeled, unlabeled]

  jobs:
    context:
      runs-on: ubuntu-latest
      steps:
        - name: Preview deployments controller
          uses: cloudposse/github-action-preview-environment-controller@main
          id: controller
          with:
            labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}
            open: ${{ github.event.pull_request.state == 'open' }}
            env-label: |
              preview: deploy
              qa1: deploy/qa1
              qa2: deploy/qa2

      outputs:
        labels_env: ${{ steps.controller.outputs.labels_env }}
        deploy_envs: ${{ steps.controller.outputs.deploy_envs }}
        destroy_envs: ${{ steps.controller.outputs.destroy_envs }}

    deploy:
      runs-on: ubuntu-latest
      if: ${{ needs.context.outputs.deploy_envs != '[]'  }}
      strategy:
        matrix:
          env: ${{ fromJson(needs.context.outputs.deploy_envs) }}
      environment:
        name: ${{ matrix.env }}
      needs: [ context ]
      steps:
        - name: Deploy
          uses: example/deploy@main
          id: deploy
          with:
            environment: ${{ matrix.env }}
            operation: deploy

    destroy:
      runs-on: ubuntu-latest
      if: ${{ needs.context.outputs.destroy_envs != '[]'  }}
      strategy:
        matrix:
          env: ${{ fromJson(needs.context.outputs.destroy_envs) }}
      needs: [ context ]
      steps:
        - name: Destroy
          uses: example/deploy@main
          id: deploy
          with:
            environment: ${{ matrix.env }}
            operation: destroy

Inputs

Name	Description	Default	Required
env-label	YAML formatted {environment}: {label} map	preview: deploy	true
labels	Existing PR labels	[]	true
open	Is PR open?	true	true

Outputs

Name	Description
deploy_envs	Environments that need to be deployed
destroy_envs	Environments that need to be destroyed
labels_env	JSON formatted {label}: {environment} map

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

github-actions-workflows - Reusable workflows for different types of projects
example-github-action-release-workflow - Example application with complicated release workflow

✨ 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.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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

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.

cloudposse / github-action-preview-environment-controller