GitHubChangesProcessor

Represents a GitHub integration configured for a project.

Extends VcsHostingChangesProcessor

Attributes

This table describes attributes of the GitHubChangesProcessor entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The database ID of the integration. `Read-only`.
server	GitHubServer	The GitHub server. `Read-only`. `Can be null`.
path	String	The relative path to the repository from the VCS base URL. `Can be null`.
branchSpecification	String	The list of branches that the integration monitors for changes. Supports regular expressions. `Can be null`.
committers	UserGroup	The group of users who can update issues with commands in their commits. `Can be null`.
project	Project	The primary project in which the integration is active. `Can be null`.
relatedProjects	Array of Projects	The list of additional projects linked to the integration.
enabled	Boolean	`true` when the integration is enabled, `false` when disabled.
visibleForGroups	Array of UserGroups	The list of user groups that can view changes made by the integration in the issue activity stream. This list is set in the "VCS changes visibility" setting in the integration settings.
addComments	Boolean	`true` when the "Parse commits for issue comments" option is enabled in the integration settings, `false` when disabled.
lookupIssuesInBranchName	Boolean	`true` when the "Issue ID lookup in VCS branch name" feature is enabled, `false` when disabled.

Last modified: 7 November 2024