Problem Statement 🍀 GitHub Actions provides the ability to create automated workloads, and CI/CD pipelines. I have 3 different branches: , , and . They have the same flow, which is to build, test, and deploy my application to Google Cloud App Engine. More details were discussed in my article on dev beta main the deployment process from GitHub to Google Cloud App Engine. In my case, only configurations (secrets and environment variables) are different. Maintaining 3 different GitHub Actions workflows, one for each, is not recommended due to duplicated code. With that said, how can I create one workflow which uses different secrets based on a triggered branch? Before we start, if you are unfamiliar with GitHub Actions, you might want to read my first! introduction to GitHub Actions components article Key points 🍀 Can I make all 3 branches trigger the same workflow? 🔑 Yes, there is a key to serve this purpose. on name: My workflow

# Define which action triggers the workflow
on: 
  # Name of the action
  push: 
    # Filter, define which branch triggers the action
    # I want all branches to trigger this workflow
    branches:       
      - dev # Direct push is allowed, this deploys to a staging server
      - beta # Protected branch, no direct push, only accepted merge is allowed
      - main # Protected branch, no direct push, only accepted merge is allowed How about statement to check for branches? 🔑 if / else if / else GitHub Actions does support the key, but there is no . Besides, I can use to read the current branch name. if else if / else contexts The syntax of contexts is , so I have something as below: ${{ <context> }} steps:
  - name: My step
    # github.ref context is used to determine the branch name
    # It is evaluated against a git's ref name

    # Wrong syntax
    # if: ${{ github.ref }} == 'something'

    # Correct syntax
    # I must use a single quote here
    # It took me a while to determine that a double quote broke the workflow
    if: ${{ github.ref == 'ref/heads/main' }}

    ... There is no key. 🔑 else if / else Well, I can use 3 different in 3 different steps. Each one represents a specific branch. if I use in the first step in my job to authenticate to GCP. At this point, I have 6 different GitHub secrets to test out the concept. Each branch has two secrets with the format and . google-github-actions/auth BRANCH_WIP BRANCH_SA # Step for the main branch
- name: MAIN authentication
  if: ${{ github.ref == 'ref/heads/main' }} && ${{ secrets.MAIN_WIP != null }} && ${{ secrets.MAIN_SA != null }}
  uses: google-github-actions/auth@v0
  with:
    workload_identity_provider: ${{ secrets.MAIN_WIP }}
    service_account: $${{ secrets.MAIN_SA }}

  ...

# Steps for beta and dev branches follow the same structure
# But, the code above will NOT work, I will explain below I use to test the workflow locally, but it fails with the message . Guess what, is not usable in key, hence the error. nektos/act Error: exit with 'FAILURE': 1 secrets if GitHub Secrets cannot be read in a conditional statement. 🔑 GitHub Actions has a key to define environment variables at different scopes in the workflow. I use it at the step level to import the because can be read in an key. env secrets env if - name: MAIN authentication
  env:
    # Define a key pair in using an environment variable.
    WIP: ${{ secrets.MAIN_WIP }}
    SA: ${{ secrets.MAIN_SA }}
  if: ${{ github.ref == 'ref/heads/main' }} && env.WIP != null && env.SA != null
  uses: google-github-actions/auth@v0
  with:
    workload_identity_provider: ${{ env.WIP }}
    service_account: ${{ env.SA }}
    # Note, I need to use '${{ }}' in reusable workflow 'auth@v0' to read 'env'
    # Meanwhile, it is not necessary in the 'if' key.
    # This cost me a fair amount of time to debug The pre-compiled codebase can read environment variables. 🔑 However, remember only what is performed inside GitHub VM can read the variables. The backend, which is uploaded to GAE, is built and tested in a GCP environment. It does not have access to GitHub resources. - name: Configuration for React environment variables
  if: ${{ github.ref == 'refs/heads/dev' }}
  # Build step can read REACT_APP_DEV
  run: |
     echo "REACT_APP_DEV=${{ secrets.DEV }}" >> $GITHUB_ENV Creating an action 3 times for 3 branches results in duplicated code, should there be a way to refactor it? 🔑 As of now, the environment variables have their scope limited to a it stays in. Inside a job, I have key, which contains multiple steps underneath. Therefore, at the minimum, I need environment variables to have scope. step steps steps Indeed, scope works. In a job, I can write the variables to at the first step in a key, so all subsequent steps can access the environment variables. Note, I cannot create a conditional statement at , so maybe only scope works after all. steps $GITHUB_ENV steps job scope steps I came across an approach using command. However, was deprecated due to CVE-2020-15228 and is not usable anymore. set-env set-env Now, I use instead. echo "MY_ENV=${{ secrets.MY_SECRET }}" >> $GITHUB_ENV name: CI/CD pipeline

# Define which action triggers the workflow
on: 
  push: 
    branches:       
      - dev # Direct push is allowed, this deploys to a staging server
      - beta # Protected branch, no direct push, only accepted merge is allowed
      - main # Protected branch, no direct push, only accepted merge is allowed

jobs:
  auth:
    name: Authenticate to GCP
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [16.x]
    permissions:
      contents: read
      id-token: write 

   steps:
     # I only need to declare environment variables once at the beginning
     # The subsequent steps can access the variables by default
    - name: Configuration for main branch
      if: ${{ github.ref == 'refs/heads/main' }}
      # Side note, I can run any Linux command here, not just 'echo'
      run: |
        echo "GCP_WIP=${{ secrets.MAIN_WIP }}" >> $GITHUB_ENV
        echo "GCP_SA=${{ secrets.MAIN_SA }}" >> $GITHUB_ENV

    - name: Configuration for beta branch
      if: ${{ github.ref == 'refs/heads/beta' }}
      run: |
        echo "GCP_WIP=${{ secrets.BETA_WIP }}" >> $GITHUB_ENV
        echo "GCP_SA=${{ secrets.BETA_SA }}" >> $GITHUB_ENV

    - name: Configuration for beta branch
      if: ${{ github.ref == 'refs/heads/dev' }}
      run: |
        echo "GCP_WIP=${{ secrets.DEV_WIP }}" >> $GITHUB_ENV
        echo "GCP_SA=${{ secrets.DEV_SA }}" >> $GITHUB_ENV    

    - name: Authenticate to GCP
      if:  env.GCP_WIP != null && env.GCP_SA != null
      uses: google-github-actions/auth@v0
      with:
        workload_identity_provider: ${{ env.GCP_WIP }}
        service_account: ${{ env.GCP_SA }}

    ... Wrap Up 🍀 Initially, my usage of GitHub Actions only involves simple actions such as , . With conditional workflow, there is a whole new set of possibilities. The article mostly focuses on conditional workflow. However, I should also be aware of some concepts that are occasionally mentioned, either directly or indirectly, throughout the article. build test Contexts Scope and hierarchical access Reusable workflow Custom Linux commands (a workflow is run in a VM) I will spend some time on the then. GitHub Actions document Also Published here

Flow

Google

FrontEnd Frameworks and Libraries to 10x Your Productivity

Nominated for 2022 - HackerNoon Contributor of the Year - Cicd

Nominated for 2022 - HackerNoon Contributor of the Year - Cloud Computing

Nominated for 2022 - HackerNoon Contributor of the Year - Debugging

Nominated for 2022 - HackerNoon Contributor of the Year - Github

Too Long; Didn't Read

Make resilience your competitive advantage

How to Create a Conditional Workflow With Advanced GitHub Actions

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

Build a New Website With Open-Source Headless CMS: Strapi, Payload, and Directus Review

104 Stories To Learn About Continuous Integration

139 Stories To Learn About Cicd

15 of the Best Continuous Delivery Tools

5 Best Microservices CI/CD Tools You Need to Check Out

Build a New Website With Open-Source Headless CMS: Strapi, Payload, and Directus Review

104 Stories To Learn About Continuous Integration

139 Stories To Learn About Cicd

15 of the Best Continuous Delivery Tools

5 Best Microservices CI/CD Tools You Need to Check Out

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps