GitHub

Discover more about the GitHub connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

GitHub interacts 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).

General tab

Parameter
Description
Default value
Data type

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The account used by the connector. It is only available if the Dynamic Account parameter is inactive.

N/A

Account

Type

The Git operation to execute.

N/A

String

Repo Name (DB)

The GitHub repository name

N/A

String

Repo Owner (DB)

The GitHub repository owner (organization).

N/A

String

Fail On Error

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 "success" property.

False

Boolean

Optional tab

Parameter
Description
Default value
Data type

Encoding (DB)

To use the given encoding when getting a Git commit file.

N/A

String

State

To set Git commit status state.

N/A

String

Target Url (DB)

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

Integer

GitHubPullRequestHeadCommitSHA (DB)

The SHA of the head of the pull request.

N/A

String

GitHubIssueTitle (DB)

The title of the issue.

N/A

String

Last updated