--- title: "GitHub Output" description: "commit TenXObject field/template values to GitHub" source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/github/module.yaml" icon: "material/github" --- Write [TenXObject](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s).") instance values to a remote file on GitHub. This output allows pipelines to dynamically generate [YAML](https://doc.log10x.com/config/yaml/) configuration and text [lookup](https://doc.log10x.com/api/js/#TenXLookup "Load and query the values of text lookup tables (.csv, .tsv) and geoIP DB files (.mmdb).") files. Subsequent pipeline instances can [pull](https://doc.log10x.com/config/github/) generated files from GitHub to guide their execution. !!! tenx-cloud "Availability" This implementation is only available by default in the 10x Engine [Compiler](https://doc.log10x.com/engine/flavors/#compiler) flavor to reduce the footprint of the [Runtime](https://doc.log10x.com/engine/flavors/#runtime) flavor. ## :material-wrench-outline: Config Files To configure the GitHub output module, [: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: [github/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/output/event/github/config.yaml "github/config.yaml"){target="\_blank"} (** Required Fields*).
Edit Online
Edit config.yaml Locally
```yaml # 🔟❎ 'run' GitHub output configuration # Write TenXObjects instance values to a remote file on GitHub. # To learn more see https://doc.log10x.com/run/output/event/github/ # Set the 10x pipeline to 'run' tenx: run # =============================== Dependencies ================================ include: - run/modules/output/event/github # ============================== Output Options =============================== # Multiple GitHub outputs can be defined below githubOutput: # ---------------------------- GitHub Options ------------------------------- # 'authToken' specifies the GitHub API with which to authenticate - token: $=yield TenXEnv.get("GH_TOKEN") # 'repo' specifies the name of the target repo (e.g., user/repo) repo: null # (❗ REQUIRED) # 'branch' specifies the target branch into which to commit. Default to main repo branch. branch: null # 'path' specifies the path of artifact within the target repo to update. path: null # 'header' specifies as header value to write to the output file (e.g., lookup columns row, YAML comments) header: null # 'message' specifies a commit message for this update message: null # 'pullRequestBody' specifies the body of the pull request used to commit and merge the target file pullRequestBody: null # 'squashMerge' specifies whether to use squash merge (true) or regular merge (false) when merging pull requests # Squash merge combines all commits into one, keeping commit history clean. Useful for frequent automated commits. squashMerge: false # --------------------------- Encoding Options ---------------------------- # 'filter' sets a JavaScript expression that TenXObjects must evaluate as truthy to write to the output. # To learn more see https://doc.log10x.com/run/output/receive/#filter-expressions filter: isObject # 'fields' defines the fields to write for each TenXObject sent to this output. # To learn more see https://doc.log10x.com/run/output/stream/#outputfields fields: - encode() # 'encodeType' specifies how 'fields' are encoded to output. Possible values: [json,delimited]. # To learn more see https://doc.log10x.com/run/output/event/outputStream/#outputstreamencodetype encodeType: json ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") multiple GitHub output: |Name|Description|Category| |---|---|---| |[githubOutputToken](#githuboutputtoken "GitHub API auth token")|GitHub API auth token|Github| |[githubOutputRepo](#githuboutputrepo "name of target repo")|Name of target repo|Github| |[githubOutputBranch](#githuboutputbranch "target branch into which to commit")|Target branch into which to commit|Github| |[githubOutputPath](#githuboutputpath "path of artifact within the target repo to update")|Path of artifact within the target repo to update|Github| |[githubOutputHeader](#githuboutputheader "header value to write to output")|Header value to write to output|Github| |[githubOutputMessage](#githuboutputmessage "commit message for target file")|Commit message for target file|Github| |[githubOutputPullRequestBody](#githuboutputpullrequestbody "pull request message for target file")|Pull request message for target file|Github| |[githubOutputSquashMerge](#githuboutputsquashmerge "use squash merge when merging pull requests")|Use squash merge when merging pull requests|Github| |[githubOutputFields](#githuboutputfields "list of TenXObject field names to encode")|List of TenXObject field names to encode|Encoding| |[githubOutputFilter](#githuboutputfilter "a JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output")|A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output|Encoding| |[githubOutputEncodeType](#githuboutputencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]")|The output format in which to encode TenXObject values. Possible values:\[json, delimited\]|Encoding| |[githubOutputEncodedLinePrefix](#githuboutputencodedlineprefix "the line prefix prepended to the encoded event if 'githubOutputEncodeType' is 'delimited'")|The line prefix prepended to the encoded event if 'githubOutputEncodeType' is 'delimited'|Encoding| |[githubOutputEncodeDelimiter](#githuboutputencodedelimiter "the delimiter placed between key and values pairs if 'githubOutputEncodeType' is 'delimited'")|The delimiter placed between key and values pairs if 'githubOutputEncodeType' is 'delimited'|Encoding| ### Github #### :material-menu-right-outline:**`githubOutputToken`** GitHub API auth token. |Type|Required|Category| |---|---|---| |String|✔|Github| Specifies the GitHub API with which to authenticate. 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:**`githubOutputRepo`** Name of target repo. |Type|Required|Category| |---|---|---| |String|✔|Github| Specifies the name of the target repo (e.g., user/repo). #### :material-menu-right-outline:**`githubOutputBranch`** Target branch into which to commit. |Type|Default|Category| |---|---|---| |String|repo default branch|Github| Specifies the name of the target repo branch. #### :material-menu-right-outline:**`githubOutputPath`** Path of artifact within the target repo to update. |Type|Required|Category| |---|---|---| |String|✔|Github| Specifies the path within the target [repo](https://doc.log10x.com/run/output/event/github/#githuboutputreponame) and [branch](https://doc.log10x.com/run/output/event/github/#githuboutputbranchname) to update. #### :material-menu-right-outline:**`githubOutputHeader`** Header value to write to output. |Type|Default|Category| |---|---|---| |String|""|Github| Specifies as header value to write to the target [path](https://doc.log10x.com/run/output/event/github/#githuboutputfilename). This value can specify a header row when emitting a .csv/.tsv lookup file or a header comment value for a .yaml file. #### :material-menu-right-outline:**`githubOutputMessage`** Commit message for target file. |Type|Default|Category| |---|---|---| |String|auto-generated message|Github| Specifies a commit message for this update. #### :material-menu-right-outline:**`githubOutputPullRequestBody`** Pull request message for target file. |Type|Default|Category| |---|---|---| |String|auto-generated message|Github| Specifies the body of the pull request used to commit and merge the target [file](https://doc.log10x.com/run/output/event/github/#githuboutputfilename) to the destination [branch](https://doc.log10x.com/run/output/event/github/#githuboutputbranchname). #### :material-menu-right-outline:**`githubOutputSquashMerge`** Use squash merge when merging pull requests. |Type|Default|Category| |---|---|---| |Boolean|false|Github| Specifies whether to use squash merge (true) or regular merge (false) when merging the pull request. Squash merge combines all commits into a single commit, resulting in a cleaner commit history. This is useful for automated commits that run frequently (e.g., GitOps policy updates). ### Encoding #### :material-menu-right-outline:**`githubOutputFields`** List of TenXObject field names to encode. |Type|Default|Category| |---|---|---| |List|\[\]|Encoding| Specifies a list of TenXObject intrinsic/calculated/extracted field names to extract and write to the output. #### :material-menu-right-outline:**`githubOutputFilter`** A JavaScript expression an TenXObject must evaluate as 'truthy' against to be written to this output. |Type|Default|Category| |---|---|---| |String|""|Encoding| Specifies a JavaScript expression that an TenXObject must evaluate as truthy to write its instance/template field values to this output. For example, to only emit [timestamped](https://doc.log10x.com/api/js/#TenXBaseObject+timestamped "Return true if length of timestamp is greater than 0") TenXObjects, specify: ```yaml githubOutputFilter: this.timestamped ``` #### :material-menu-right-outline:**`githubOutputEncodeType`** The output format in which to encode TenXObject values. Possible values:\[json, delimited\]. |Type|Default|Category| |---|---|---| |String|delimited|Encoding| Specifies how to encode [githubOutputFields](https://doc.log10x.com/run/output/event/github/#githuboutputfields "list of TenXObject field names to encode") values to this output. Possible values: - **json**: formats names and values for the current TenXObject as: {"field":"str","field2":1, "field3": true} - **delimited**: formats values for the current TenXObject as: "str",1,true The 'githubOutputEncodeDelimiter' argument determines the separator to use. #### :material-menu-right-outline:**`githubOutputEncodedLinePrefix`** The line prefix prepended to the encoded event if 'githubOutputEncodeType' is 'delimited'. |Type|Default|Category| |---|---|---| |String||Encoding| Sets the char which is prepended to the emitted TenXObject field values when [githubOutputEncodeType](https://doc.log10x.com/run/output/event/github/#githuboutputencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is `delimited`. #### :material-menu-right-outline:**`githubOutputEncodeDelimiter`** The delimiter placed between key and values pairs if 'githubOutputEncodeType' is 'delimited'. |Type|Default|Category| |---|---|---| |String| |Encoding| Sets the char delimiter to separate TenXObject field values when [githubOutputEncodeType](https://doc.log10x.com/run/output/event/github/#githuboutputencodetype "the output format in which to encode TenXObject values. Possible values:[json, delimited]") is 'delimited'.
:material-github: This module is defined in [github/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/output/event/github/module.yaml "github/module.yaml"){target="\_blank"}.