GitHub
Discover more about the GitHub connector and how to use it on the Digibee Integration Platform.
Important information:
This documentation is currently available only in English but will soon be translated into Portuguese.
The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.
Interact with the GitHub API.
Parameters
Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB)
.
Required Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Dynamic Account | When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically. | false | boolean |
Account Name | The name of the account that is generated dynamically via the Store Account connector. | string | |
Account | Sets the account to be used by the connector. | N/A | account |
Type | What git operation to execute | string | |
Repo Name | GitHub repository name | N/A | string |
Repo Owner | GitHub repository owner (organization) | N/A | string |
Fail On Error | If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false | false | boolean |
Optional Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Encoding | To use the given encoding when getting a git commit file | N/A | string |
State | To set git commit status state | string | |
Target Url | To set git commit status target url | N/A | string |
Headers Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
GitHubInResponseTo | The id of the comment to reply to | N/A | number |
GitHubPullRequestHeadCommitSHA | The sha of the head of the pull request | N/A | string |
GitHubIssueTitle | The title of the issue | N/A | string |
Successful executions should output at least a property "success": true
Last updated