GitHub Action to Build, Push, and Deploy OpenFaaS Functions/Microservices

This action is designed to deploy functions or microservices developed with OpenFaaS.

Your repository can be organized in one of the following ways:

1. A single stack.yml file and dev-deploy/prod-deploy/qa-deploy.yml file in the function path for each function.

   your-repo/
     ├── function 1/
     │   └── handler.js
     │   └── dev-deploy.yml
     │   └── qa-deploy.yml
     │   └── prod-deploy.yml  
     ├── function 2/
     │   └── handler.js
     │   └── dev-deploy.yml
     │   └── qa-deploy.yml
     │   └── prod-deploy.yml
     │
     └── global-dev-deploy.yml
     └── global-prod-deploy.yml
     └── global-qa-deploy.yml     
     └── stack.yml

  This method will result in function being built, pushed, and deployed every time something changes in the function path. 

2. Functions grouped into related folders, each with their own stack.yml file and dev-deploy/prod-deploy/qa-deploy.yml files (For repos with a large number of functions)

   your-repo/
     ├── group-1/
     │   ├── function 1/
     │   │   └── handler.js
     │   │   └── dev-deploy.yml
     │   │   └── qa-deploy.yml
     │   │   └── prod-deploy.yml  
     │   ├── function 2/
     │   │   └── handler.js
     │   │   └── dev-deploy.yml
     │   │   └── qa-deploy.yml
     │   └── └── prod-deploy.yml
     │   └── global-dev-deploy.yml
     │   └── global-prod-deploy.yml
     │   └── global-qa-deploy.yml         
     │   └── stack.yml
     │
     └── group-2/
     │   ├── function 1/
     │   │   └── handler.js
     │   │   └── dev-deploy.yml
     │   │   └── qa-deploy.yml
     │   │   └── prod-deploy.yml  
     │   ├── function 2/
     │   │   └── handler.js
     │   │   └── dev-deploy.yml
     │   │   └── qa-deploy.yml
     │   └── └── prod-deploy.yml
     │   └── global-dev-deploy.yml
     │   └── global-prod-deploy.yml
     │   └── global-qa-deploy.yml
     │   └── stack.yml          
     │        
     └── group-3/   

  Function folder names must correspond exactly to the name of a function in the stack.yml in its group folder.
  In addition, this method will only build, push, and deploy based on which files changed in the last commit. So if any files changed in a given function's folder, that function will be deployed. 

Usage

Commits to master branch

If changes are made to one function specifically and are included in the PR, when merged

 1. Triggers release.yml action checks the function updated based on the path of the files changed
       └── if the PR title merged includes(fix/feat/perf(BREAKING CHANGE)) prefixes, a new release and tag is created
              └── for "fix" prefix - `p` is updated in M.n.p
              └── for "feat" prefix - `n` is updated in M.n.p
              └── for "perf"(included with BREAKING CHANGE) prefix - `M` is updated in M.n.p
 2. Updates to a handler.js of the function when pushed to master
       └── Triggers auto-dev-deploy.yml action which auto-deploys updated function to DEV environment
 3. If package.json is updated(or when the release is created which updates the version in package.json)
       └── build_push.yml action is triggered, builds and pushes the function image with updated tag.

NOTE: Make sure to not combine updates to deploy file with the above function update commit/merge and keep them separate.

If deploy files are updated with image tag AND/OR function specific env variables, constraints, labels, secrets

 1. If the qa-deploy.yml/prod-deploy.yml is updated
       >> deploy.yml workflow is triggered. 
            1. if qa-deploy/prod-deploy.yml is updated with the new image tag.
                └── The function with updated version is deployed to the QA/PROD environment respectively. 
            2. if qa-deploy/prod-deploy.yml is updated with only new env variables(image tag remains same)
                └── Re-deploys the function with same tag but with updated env variables to DEV environment. 
 2. Update to dev-deploy.yml(environment variables/secrets/labels/constraints etc.)
      └── Triggers auto-dev-deploy.yml action, builds, pushes and automatically deploys to the DEV environment
 3. Updates to stack.yml does not trigger any actions, although updated configurations will be used the next time deploy action runs.

Group deploy

 1. If the multiple deploy files for the functions in a group is updated, 
 for example:
    └── In a group of 6 functions, if qa-deploy.yml is updated for 4 functions, 4 functions of 6 in the group are deployed to the qa cluster.

NOTE: updating global-*-deploy.yml files will deploy all the functions in the group path to the target environment based on the file updated.

On Pull request to master branch

Triggers status.yml action to run function build for all the updated functions for status check.