GitHub Push Committer

Push symbol unit and library files to GitHub for use by subsequent run and compile pipeline execution.

Compile

Compile pipelines pull prior outputs to skip unchanged files, reducing compilation time and keeping apps current.

Run

Run pipelines pull symbol libraries at startup or periodically to transform events via GitOps configuration.

Configuration

To configure the GitHub push committer unit, Edit these settings.

Below is the default configuration from: push/config.yaml (* Required Fields).

Edit Online Edit Locally

Edit config.yaml Locally

Download and save to:

• Linux / Docker / macOS
• Custom directory
  $TENX_CONFIG/compile/push/config.yaml
• Within cloned repo
  ./pipelines/compile/push/config.yaml

Download

# 🔟❎ 'compile' GitHub configuration

# Push output symbol unit files for reuse by subsequent compile cycles.
# To learn more see https://doc.log10x.com/compile/push/

# Set the 10x pipeline to 'compile'
tenx: compile

# =============================== GitHub Options ==============================

githubPush:

    # 'token' specifies the access token for pushing files to the target repo, read from env or set inline.
    #  To learn more see: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
  - token: $=TenXEnv.get("GH_TOKEN") # (❗ EnvVar REQUIRED)

    # 'repo' specifies the repo name to pull in Github
    #  including the username of the owner (e.g., apache/spark)
    repo: null # (❗ REQUIRED)

    # 'branch' specifies the branch to use when pushing into this repo.
    #  If not specified, push to the default repo branch
    branch: null

    # 'folder' specifies a folder within the target repo to push files, if not specified push to root
    folder: null

    # 'filter' specifies a a regex pattern a file on disk must match to be pushed to the target repo.
    filter: null

Options

Specify the options below to configure multiple GitHub push committer:

Name	Description
githubPushRepo	Target GitHub repo
githubPushToken	GitHub API access token
githubPushBranch	Target branch to push to
githubPushFolder	Folder within the target GitHub repo in which to push files
githubPushFilter	A regex pattern a file on disk must match to push

githubPushRepo

Target GitHub repo.

Type	Default
String	""

Identifies a GitHub repository to push files to including the username of the owner (e.g., 'some-user/repo-name').

githubPushToken

GitHub API access token.

Type	Default
String	""

Defines an access token for accessing Github repos. To learn more see GitHub tokens.

githubPushBranch

Target branch to push to.

Type	Default
String	""

Specifies the branch to use when pushing to this repo. If omitted, use the repository's default branch.

githubPushFolder

Folder within the target GitHub repo in which to push files.

Type	Default
String	""

Identifies a folder within the target GitHub repo to push output symbol files to.

githubPushFilter

A regex pattern a file on disk must match to push.

Type	Default
String	""

Specifies a a regex pattern a file on disk must match to be pushed to the target repo. This option provides a mechanism for 'routing' output symbol files to different repositories based on their file extension (e.g., \.js\.json$) or location within the output folder tree (e.g., (^|/|\\)acme(/|\\|$).

This unit is defined in push/unit.yaml.