---
title: "GitHub Push Committer"
description: "push output symbol unit files to GitHub"
source: "https://github.com/log-10x/modules/tree/main/pipelines/compile/units/push/unit.yaml"
icon: "material/source-commit"
---
Push symbol unit and library files to GitHub for use by subsequent run and compile pipeline execution.
The pushed files are consumed by two downstream readers.
### :material-cogs: Compile
Compile pipelines [pull](https://doc.log10x.com/compile/sources/ "Locate source code, binary, executable, and text files to scan") prior outputs to skip unchanged files, reducing compilation time and keeping [apps](https://doc.log10x.com/apps/) current.
### :material-play: Run
Run pipelines [pull](https://doc.log10x.com/config/github/) symbol libraries from GitHub at startup or periodically to [transform](https://doc.log10x.com/run/transform/ "Transform log and trace events into well-defined TenXObjects") events via [GitOps](https://doc.log10x.com/engine/gitops/) configuration. Kubernetes deployments can instead source action-intent CSV and JSON keys from a [ConfigMap](https://doc.log10x.com/config/k8s/) mounted by the @kubernetes launch macro, which reloads on atomic rename.
## :material-wrench-outline: Config Files
To configure the GitHub push committer unit, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files.
Below is the default configuration from: [push/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/compile/push/config.yaml "push/config.yaml"){target="\_blank"} (** Required Fields*).
ewogICJ0eXBlIiA6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIiA6IHsKICAgICJ0ZW54IiA6IHsKICAgICAgInR5cGUiIDogInN0cmluZyIKICAgIH0sCiAgICAiZ2l0aHViUHVzaCIgOiB7CiAgICAgICJ0eXBlIiA6ICJhcnJheSIsCiAgICAgICJpdGVtcyIgOiB7CiAgICAgICAgInR5cGUiIDogIm9iamVjdCIsCiAgICAgICAgImFkZGl0aW9uYWxQcm9wZXJ0aWVzIiA6IGZhbHNlLAogICAgICAgICJwcm9wZXJ0aWVzIiA6IHsKICAgICAgICAgICJyZXBvIiA6IHsKICAgICAgICAgICAgInR5cGUiIDogWwogICAgICAgICAgICAgICJzdHJpbmciLAogICAgICAgICAgICAgICJudWxsIgogICAgICAgICAgICBdLAogICAgICAgICAgICAibWFya2Rvd25EZXNjcmlwdGlvbiIgOiAiVGFyZ2V0IEdpdEh1YiByZXBvXG5cbklkZW50aWZpZXMgYSBHaXRIdWIgcmVwb3NpdG9yeSB0byBwdXNoIGZpbGVzIHRvIGluY2x1ZGluZyB0aGUgdXNlcm5hbWUgb2YgdGhlIG93bmVyIChlLmcuLCAnc29tZS11c2VyL3JlcG8tbmFtZScpIgogICAgICAgICAgfSwKICAgICAgICAgICJ0b2tlbiIgOiB7CiAgICAgICAgICAgICJ0eXBlIiA6IFsKICAgICAgICAgICAgICAic3RyaW5nIiwKICAgICAgICAgICAgICAibnVsbCIKICAgICAgICAgICAgXSwKICAgICAgICAgICAgIm1hcmtkb3duRGVzY3JpcHRpb24iIDogIkdpdEh1YiBBUEkgYWNjZXNzIHRva2VuXG5cbkRlZmluZXMgYW4gYWNjZXNzIHRva2VuIGZvciBhY2Nlc3NpbmcgR2l0aHViIHJlcG9zLiBUbyBsZWFybiBtb3JlIHNlZSBbR2l0SHViIHRva2Vuc10oaHR0cHM6Ly9kb2NzLmdpdGh1Yi5jb20vZW4vYXV0aGVudGljYXRpb24va2VlcGluZy15b3VyLWFjY291bnQtYW5kLWRhdGEtc2VjdXJlL21hbmFnaW5nLXlvdXItcGVyc29uYWwtYWNjZXNzLXRva2VucykuIgogICAgICAgICAgfSwKICAgICAgICAgICJicmFuY2giIDogewogICAgICAgICAgICAidHlwZSIgOiBbCiAgICAgICAgICAgICAgInN0cmluZyIsCiAgICAgICAgICAgICAgIm51bGwiCiAgICAgICAgICAgIF0sCiAgICAgICAgICAgICJtYXJrZG93bkRlc2NyaXB0aW9uIiA6ICJUYXJnZXQgYnJhbmNoIHRvIHB1c2ggdG9cblxuU3BlY2lmaWVzIHRoZSBicmFuY2ggdG8gdXNlIHdoZW4gcHVzaGluZyB0byB0aGlzIHJlcG8uIElmIG9taXR0ZWQsIHVzZSB0aGUgcmVwb3NpdG9yeSdzIGRlZmF1bHQgYnJhbmNoLiIKICAgICAgICAgIH0sCiAgICAgICAgICAiZm9sZGVyIiA6IHsKICAgICAgICAgICAgInR5cGUiIDogWwogICAgICAgICAgICAgICJzdHJpbmciLAogICAgICAgICAgICAgICJudWxsIgogICAgICAgICAgICBdLAogICAgICAgICAgICAibWFya2Rvd25EZXNjcmlwdGlvbiIgOiAiRm9sZGVyIHdpdGhpbiB0aGUgdGFyZ2V0IEdpdEh1YiByZXBvIGluIHdoaWNoIHRvIHB1c2ggZmlsZXNcblxuSWRlbnRpZmllcyBhIGZvbGRlciB3aXRoaW4gdGhlIHRhcmdldCBHaXRIdWIgcmVwbyB0byBwdXNoIG91dHB1dCBzeW1ib2wgZmlsZXMgdG8iCiAgICAgICAgICB9LAogICAgICAgICAgImZpbHRlciIgOiB7CiAgICAgICAgICAgICJ0eXBlIiA6IFsKICAgICAgICAgICAgICAic3RyaW5nIiwKICAgICAgICAgICAgICAibnVsbCIKICAgICAgICAgICAgXSwKICAgICAgICAgICAgIm1hcmtkb3duRGVzY3JpcHRpb24iIDogIkEgcmVnZXggcGF0dGVybiBhIGZpbGUgb24gZGlzayBtdXN0IG1hdGNoIHRvIHB1c2hcblxuU3BlY2lmaWVzIGEgYSByZWdleCBwYXR0ZXJuIGEgZmlsZSBvbiBkaXNrIG11c3QgbWF0Y2ggdG8gYmUgcHVzaGVkIHRvIHRoZSB0YXJnZXQgcmVwby4gVGhpcyBvcHRpb24gcHJvdmlkZXMgYSBtZWNoYW5pc20gZm9yICdyb3V0aW5nJyBvdXRwdXQgc3ltYm9sIGZpbGVzIHRvIGRpZmZlcmVudCByZXBvc2l0b3JpZXMgYmFzZWQgb24gdGhlaXIgZmlsZSBleHRlbnNpb24gKGUuZy4sIGBcXC5qc1xcLmpzb24kYCkgb3IgbG9jYXRpb24gd2l0aGluIHRoZSBvdXRwdXQgZm9sZGVyIHRyZWUgKGUuZy4sIGAoXnwvfFxcXFwpYWNtZSgvfFxcXFx8JGApIgogICAgICAgICAgfQogICAgICAgIH0sCiAgICAgICAgInJlcXVpcmVkIiA6IFsKICAgICAgICAgICJyZXBvIgogICAgICAgIF0KICAgICAgfQogICAgfQogIH0sCiAgImFkZGl0aW9uYWxQcm9wZXJ0aWVzIiA6IGZhbHNlCn0=
```yaml
# 🔟❎ '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
```
## :material-menu: Options
Specify the options below to [configure](/config "configure") multiple GitHub push committer:
|Name|Description|
|---|---|
|[githubPushRepo](#githubpushrepo "target GitHub repo")|Target GitHub repo|
|[githubPushToken](#githubpushtoken "GitHub API access token")|GitHub API access token|
|[githubPushBranch](#githubpushbranch "target branch to push to")|Target branch to push to|
|[githubPushFolder](#githubpushfolder "folder within the target GitHub repo in which to push files")|Folder within the target GitHub repo in which to push files|
|[githubPushFilter](#githubpushfilter "a regex pattern a file on disk must match to push")|A regex pattern a file on disk must match to push|
### :material-menu-right-outline:**`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').
### :material-menu-right-outline:**`githubPushToken`**
GitHub API access token.
|Type|Default|
|---|---|
|String|""|
Defines an access token for accessing Github repos.
To learn more see [GitHub tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens){target="\_blank"}.
### :material-menu-right-outline:**`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.
### :material-menu-right-outline:**`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.
### :material-menu-right-outline:**`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(/|\\|$`).
:material-github: This unit is defined in [push/unit.yaml](https://github.com/log-10x/modules/tree/main/pipelines/compile/units/push/unit.yaml "push/unit.yaml"){target="\_blank"}.