# GitHub

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**GitHub** interacts with the GitHub API.

## **Parameters**

Take a look at the configuration options for the component. Parameters supported by [Double Braces expressions](https://docs.digibee.com/documentation/connectors-and-triggers/double-braces/overview) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>When active, the connector will use the account dynamically. Otherwise, it will use the account statically.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>The name of the dynamic account used by the connector. This account must have been previously configured in a <a href="../tools/store-account"><strong>Store Account</strong></a> connector in the pipeline for this process to take effect. It is only available if the <strong>Dynamic Account</strong> parameter is active.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>The account used by the connector. It is only available if the <strong>Dynamic Account</strong> parameter is inactive.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Type</strong></td><td>The Git operation to execute.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Repo Name</strong> <code>(DB)</code></td><td>The GitHub repository name</td><td>N/A</td><td>String</td></tr><tr><td><strong>Repo Owner</strong> <code>(DB)</code></td><td>The GitHub repository owner (organization).</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Encoding</strong> <code>(DB)</code></td><td>To use the given encoding when getting a Git commit file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>State</strong></td><td>To set Git commit status state.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Target Url</strong> <code>(DB)</code></td><td>To set Git commit status target URL.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>GitHubInResponseTo</strong></td><td>The ID of the comment to reply to.</td><td>N/A</td><td>Integer</td></tr><tr><td><strong>GitHubPullRequestHeadCommitSHA</strong> <code>(DB)</code></td><td>The SHA of the head of the pull request.</td><td>N/A</td><td>String</td></tr><tr><td><strong>GitHubIssueTitle</strong> <code>(DB)</code></td><td>The title of the issue.</td><td>N/A</td><td>String</td></tr></tbody></table>
