Github¶

Node: github · Full type: n8n-nodes-base.github · Version: 1.1

Credentials¶

githubApi (alias: @github) / githubOAuth2Api (alias: @github)

CREDENTIAL @github = githubApi "My Github"

Operations¶

Resource: `file`¶

`create`¶

Parameter	Type	Default	Details
`binaryData`	boolean	false	required
`fileContent`	string	""	required
`binaryPropertyName`	string	"data"	required
`commitMessage`	string	""	required
`additionalParameters`	fixedCollection	{}	groups: `author`, `branch`, `committer`

`delete`¶

Parameter	Type	Default	Details
`commitMessage`	string	""	required
`additionalParameters`	fixedCollection	{}	groups: `author`, `branch`, `committer`

`edit`¶

Parameter	Type	Default	Details
`binaryData`	boolean	false	required
`fileContent`	string	""	required
`binaryPropertyName`	string	"data"	required
`commitMessage`	string	""	required
`additionalParameters`	fixedCollection	{}	groups: `author`, `branch`, `committer`

`get`¶

Parameter	Type	Default	Details
`asBinaryProperty`	boolean	true
`binaryPropertyName`	string	"data"	required
`additionalParameters`	collection	{}	keys: `reference`

`list`¶

Parameter	Type	Default	Details
`filePath`	string	""

Resource: `issue`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`body`	string	""
`labels`	collection	{...}	keys: `label`
`assignees`	collection	{...}	keys: `assignee`

`createComment`¶

Parameter	Type	Default	Details
`issueNumber`	number	0	required
`body`	string	""

`edit`¶

Parameter	Type	Default	Details
`issueNumber`	number	0	required
`editFields`	collection	{}	keys: `assignees`, `body`, `labels`, `state`, `state_reason`, `title`

`get`¶

Parameter	Type	Default	Details
`issueNumber`	number	0	required

`lock`¶

Parameter	Type	Default	Details
`issueNumber`	number	0	required
`lockReason`	options	"resolved"	`off-topic`, `too heated`, `resolved`, `spam`

Resource: `organization`¶

`getRepositories`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

Resource: `release`¶

`create`¶

Parameter	Type	Default	Details
`releaseTag`	string	""	required
`additionalFields`	collection	{}	keys: `name`, `body`, `draft`, `prerelease`, `target_commitish`

`delete`¶

Parameter	Type	Default	Details
`release_id`	string	""	required

`get`¶

Parameter	Type	Default	Details
`release_id`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`release_id`	string	""	required
`additionalFields`	collection	{}	keys: `body`, `draft`, `name`, `prerelease`, `tag_name`, `target_commitish`

Resource: `repository`¶

`get`¶

No additional parameters.

`getIssues`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`getRepositoryIssuesFilters`	collection	{}	keys: `assignee`, `creator`, `mentioned`, `labels`, `since`, `state`, ...

`getLicense`¶

No additional parameters.

`getProfile`¶

No additional parameters.

`getPullRequests`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`getRepositoryPullRequestsFilters`	collection	{}	keys: `state`, `sort`, `direction`

`listPopularPaths`¶

No additional parameters.

`listReferrers`¶

No additional parameters.

Resource: `review`¶

`create`¶

Parameter	Type	Default	Details
`pullRequestNumber`	number	0	required
`event`	options	"approve"	`approve`, `requestChanges`, `comment`, `pending`
`body`	string	""
`additionalFields`	collection	{}	keys: `commitId`

`get`¶

Parameter	Type	Default	Details
`pullRequestNumber`	number	0	required
`reviewId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`pullRequestNumber`	number	0	required
`returnAll`	boolean	false
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`pullRequestNumber`	number	0	required
`reviewId`	string	""	required
`body`	string	""

Resource: `user`¶

`getRepositories`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50

`getUserIssues`¶

No additional parameters.

`invite`¶

Parameter	Type	Default	Details
`organization`	string	""	required
`email`	string	""	required

Resource: `workflow`¶

`disable`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`

`dispatch`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`
`ref`	string	"main"	required
`ref`	resourceLocator	{...}	required; modes: `list`, `name`
`inputs`	json	"{}"

`dispatchAndWait`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`
`ref`	string	"main"	required
`ref`	resourceLocator	{...}	required; modes: `list`, `name`
`inputs`	json	"{}"

`enable`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`

`get`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`

`getUsage`¶

Parameter	Type	Default	Details
`workflowId`	resourceLocator	{...}	required; modes: `list`, `filename`, `name`

`list`¶

No additional parameters.

Common Parameters¶

Parameter	Type	Default	Details
`authentication`	options	"accessToken"	`accessToken`, `oAuth2`
`owner`	resourceLocator	{...}	required; modes: `list`, `url`, `name`
`repository`	resourceLocator	{...}	required; modes: `list`, `url`, `name`
`filePath`	string	""	required

Parameter Details¶

additionalParameters children:

author group:

Parameter	Type	Default	Details
`name`	string	""
`email`	string	""

branch group:

Parameter	Type	Default	Details
`branch`	string	""

committer group:

Parameter	Type	Default	Details
`name`	string	""
`email`	string	""

labels children:

Parameter	Type	Default	Details
`label`	string	""

assignees children:

Parameter	Type	Default	Details
`assignee`	string	""

editFields children:

Parameter	Type	Default	Details
`assignees`	collection	{...}	keys: `assignee`
`body`	string	""
`labels`	collection	{...}	keys: `label`
`state`	options	"open"	`closed`, `open`
`state_reason`	options	"completed"	`completed`, `not_planned`, `reopened`
`title`	string	""

additionalFields children:

Parameter	Type	Default
`name`	string	""
`body`	string	""
`draft`	boolean	false
`prerelease`	boolean	false
`target_commitish`	string	""

getRepositoryIssuesFilters children:

Parameter	Type	Default	Details
`assignee`	string	""
`creator`	string	""
`mentioned`	string	""
`labels`	string	""
`since`	dateTime	""
`state`	options	"open"	`all`, `closed`, `open`
`sort`	options	"created"	`created`, `updated`, `comments`
`direction`	options	"desc"	`asc`, `desc`

getRepositoryPullRequestsFilters children:

Parameter	Type	Default	Details
`state`	options	"open"	`all`, `closed`, `open`
`sort`	options	"created"	`created`, `updated`, `popularity`, `long-running`
`direction`	options	"desc"	`asc`, `desc`

getUserIssuesFilters children:

Parameter	Type	Default	Details
`mentioned`	string	""
`labels`	string	""
`since`	dateTime	""
`state`	options	"open"	`all`, `closed`, `open`
`sort`	options	"created"	`created`, `updated`, `comments`
`direction`	options	"desc"	`asc`, `desc`

Example¶

NODE "github" @github AS "Github" {
  resource: "file",
  operation: "get",
  ref: {{ $json.ref }},
  filePath: {{ $json.filePath }},
  fileContent: {{ $json.fileContent }}
}

Github¶

Credentials¶

Operations¶

Resource: file¶

create¶

delete¶

edit¶

get¶

list¶

Resource: issue¶

create¶

createComment¶

edit¶

get¶

lock¶

Resource: organization¶

getRepositories¶

Resource: release¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: repository¶

get¶

getIssues¶

getLicense¶

getProfile¶

getPullRequests¶

listPopularPaths¶

listReferrers¶

Resource: review¶

create¶

get¶

getAll¶

update¶

Resource: user¶

getRepositories¶

getUserIssues¶

invite¶

Resource: workflow¶

disable¶

dispatch¶

dispatchAndWait¶

enable¶

get¶

getUsage¶

list¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `file`¶

`create`¶

`delete`¶

`edit`¶

`get`¶

`list`¶

Resource: `issue`¶

`create`¶

`createComment`¶

`edit`¶

`get`¶

`lock`¶

Resource: `organization`¶

`getRepositories`¶

Resource: `release`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `repository`¶

`get`¶

`getIssues`¶

`getLicense`¶

`getProfile`¶

`getPullRequests`¶

`listPopularPaths`¶

`listReferrers`¶

Resource: `review`¶

`create`¶

`get`¶

`getAll`¶

`update`¶

Resource: `user`¶

`getRepositories`¶

`getUserIssues`¶

`invite`¶

Resource: `workflow`¶

`disable`¶

`dispatch`¶

`dispatchAndWait`¶

`enable`¶

`get`¶

`getUsage`¶

`list`¶