sync_from_github.py

# This flow is registered as webhook, triggered by a commit to the
# repository. When started manually, it will sync from master.

# The flow script will sync all files from the github repository specified
# in the "github_info" setting. It will create flow script from all files
# ending with .py and create settings from all files ending with .yaml.

# You can set up the webhooks on github to trigger this flow script using the
# configure_webhooks_github_cloudomation flow script, which is available in the
# public flow script library. You can use another flow script to guide you
# through the process of setting up a github repository. It's called
# request_github_info and is also available in the public flow script library.

# For the full process, you need the following three flow scripts:
# 1. configure_webhoooks_github_cloudomation
# 2. request_github_info
# 3. sync_from_github (this one)

# This flow script is the only one you need continously to syncronise flow
# scripts from your github repository. The other two you need once to set it
# all up.

# Note that once you have this set up, this flow script will ALWAYS check out
# your github repository WHENEVER THERE IS A PUSH. Make sure that you set this
# up to synchronise only a repository that you want to regularly synchronise
# with Cloudomation.

# If you want to stop synchronising files from your github repository with
# Cloudomation, the easiest way is to disable the webhook on github. You can
# also remove or rename the webhook on Cloudomation, but that will lead to
# errors on the side of your github webhook, which will still try to send
# notifications to the Cloudomation webhook.

import yaml
import os


def handler(system, this):
    inputs = this.get('input_value')
    try:
        commit_sha = inputs['data_json']['commit_sha']
    except Exception:
        commit_sha = 'origin/master'

    # read the connection information of the private repository
    repo_info = system.setting('github_info').get('value')
    github_username = repo_info['github_username']
    github_repo_name = repo_info['github_repo_name']
    github_token = repo_info['github_token']

    repo_url = (
        f'https://{github_username}:{github_token}@github.com/'
        f'{github_username}/{github_repo_name}.git'
    )

    this.task(
        'GIT',
        command='get',
        repository_url=repo_url,
        repository_path='synced_from_git',
        ref=commit_sha,
    )
    # the git 'get' command ensures the content of the repository in a local
    # folder. it will clone or fetch and merge.

    # list all flows from the repository
    # this call will return a list of File objects
    files = system.files(dir='synced_from_git', glob='**/*.py')
    this.log(files=files)
    for file in files:
        # access the path field of the file object
        path = file.get('path')
        # ignore any subdirectory and extension
        name, ext = os.path.splitext(os.path.basename(path))
        # access the content of the file
        content = file.get('content')
        # create a new Flow object
        system.flow(name=name, script=content)
    # repeat the same for yaml files and Setting objects
    files = system.files(dir='synced_from_git', glob='**/*.yaml')
    this.log(files=files)
    for file in files:
        path = file.get('path')
        name, ext = os.path.splitext(os.path.basename(path))
        content = file.get('content')
        value = yaml.safe_load(content)
        system.setting(name=name, value=value)

    this.success('Github sync complete')