github.json•21.9 kB
{
"nodeType": "n8n-nodes-base.github",
"displayName": "GitHub",
"description": "Consume GitHub API",
"version": [
1,
1.1
],
"properties": [
{
"name": "authentication",
"displayName": "Authentication",
"type": "options",
"default": "accessToken",
"options": [
{
"name": "Access Token",
"value": "accessToken"
},
{
"name": "OAuth2",
"value": "oAuth2"
}
]
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "issue",
"options": [
{
"name": "File",
"value": "file"
},
{
"name": "Issue",
"value": "issue"
},
{
"name": "Organization",
"value": "organization"
},
{
"name": "Release",
"value": "release"
},
{
"name": "Repository",
"value": "repository"
},
{
"name": "Review",
"value": "review"
},
{
"name": "User",
"value": "user"
},
{
"name": "Workflow",
"value": "workflow"
}
]
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "getRepositories",
"description": "Returns all repositories of an organization",
"options": [
{
"name": "Get Repositories",
"value": "getRepositories",
"description": "Returns all repositories of an organization"
}
],
"displayOptions": {
"show": {
"resource": [
"organization"
]
}
}
},
{
"name": "webhookNotice",
"displayName": "Your execution will pause until a webhook is called. This URL will be generated at runtime and passed to your Github workflow as a resumeUrl input.",
"type": "notice",
"default": "",
"displayOptions": {
"show": {
"resource": [
"workflow"
],
"operation": [
"dispatchAndWait"
]
}
}
},
{
"name": "owner",
"displayName": "Repository Owner",
"type": "resourceLocator",
"default": "{ mode: 'list', value: '' }",
"placeholder": "Select an owner...",
"required": true,
"displayOptions": {
"hide": {
"operation": [
"invite"
]
}
}
},
{
"name": "repository",
"displayName": "Repository Name",
"type": "resourceLocator",
"default": "{\n\t\t\t\t\tmode: 'list',\n\t\t\t\t\tvalue: '',\n\t\t\t\t}",
"placeholder": "Select an Repository...",
"required": true,
"displayOptions": {
"hide": {
"resource": [
"user",
"organization"
],
"operation": [
"getRepositories"
]
}
}
},
{
"name": "workflowId",
"displayName": "Workflow",
"type": "resourceLocator",
"default": "{\n\t\t\t\t\tmode: 'list',\n\t\t\t\t\tvalue: '',\n\t\t\t\t}",
"description": "The workflow to dispatch",
"placeholder": "Select a workflow...",
"required": true,
"displayOptions": {
"show": {
"resource": [
"workflow"
],
"operation": [
"disable",
"dispatch",
"dispatchAndWait",
"get",
"getUsage",
"enable"
]
}
}
},
{
"name": "ref",
"displayName": "Ref",
"type": "string",
"default": "main",
"description": "The git reference for the workflow dispatch (branch or tag name)",
"required": true,
"displayOptions": "{\n\t\t\t\t\tshow: {\n\t\t\t\t\t\tresource: ['workflow'],\n\t\t\t\t\t\toperation: ['dispatch', 'dispatchAndWait'],\n\t\t\t\t\t\t'@version': [{ _cnd: { lte: 1 }"
},
{
"name": "inputs",
"displayName": "Inputs",
"type": "json",
"default": "{}",
"description": "JSON object with input parameters for the workflow",
"displayOptions": {
"show": {
"resource": [
"workflow"
],
"operation": [
"dispatch",
"dispatchAndWait"
]
}
}
},
{
"name": "filePath",
"displayName": "File Path",
"type": "string",
"default": "",
"description": "The file path of the file. Has to contain the full path.",
"placeholder": "docs/README.md",
"required": true,
"displayOptions": {
"show": {
"resource": [
"file"
]
}
}
},
{
"name": "binaryData",
"displayName": "Binary File",
"type": "boolean",
"default": false,
"description": "Whether the data to upload should be taken from binary field",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create",
"edit"
],
"resource": [
"file"
]
}
}
},
{
"name": "fileContent",
"displayName": "File Content",
"type": "string",
"default": "",
"description": "The text content of the file",
"placeholder": "",
"required": true,
"displayOptions": {
"show": {
"binaryData": [
false
],
"operation": [
"create",
"edit"
],
"resource": [
"file"
]
}
}
},
{
"name": "binaryPropertyName",
"displayName": "Input Binary Field",
"type": "string",
"default": "data",
"placeholder": "",
"required": true,
"displayOptions": {
"show": {
"binaryData": [
true
],
"operation": [
"create",
"edit"
],
"resource": [
"file"
]
}
}
},
{
"name": "commitMessage",
"displayName": "Commit Message",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create",
"delete",
"edit"
],
"resource": [
"file"
]
}
}
},
{
"name": "additionalParameters",
"displayName": "Additional Parameters",
"type": "fixedCollection",
"default": {},
"description": "Additional fields to add",
"placeholder": "Add Parameter",
"displayOptions": {
"show": {
"operation": [
"create",
"delete",
"edit"
],
"resource": [
"file"
]
}
}
},
{
"name": "asBinaryProperty",
"displayName": "As Binary Property",
"type": "boolean",
"default": true,
"description": "Whether to set the data of the file as binary property instead of returning the raw API response",
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"file"
]
}
}
},
{
"name": "title",
"displayName": "Title",
"type": "string",
"default": "",
"description": "The title of the issue",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"issue"
]
}
}
},
{
"name": "body",
"displayName": "Body",
"type": "string",
"default": "",
"description": "The body of the issue",
"typeOptions": {
"rows": 5
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"issue"
]
}
}
},
{
"name": "labels",
"displayName": "Labels",
"type": "collection",
"default": {},
"description": "Label to add to issue",
"options": [
{
"name": "label",
"displayName": "Label",
"type": "string",
"default": "",
"description": "Label to add to issue"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"issue"
]
}
}
},
{
"name": "assignees",
"displayName": "Assignees",
"type": "collection",
"default": {},
"description": "User to assign issue too",
"options": [
{
"name": "assignee",
"displayName": "Assignee",
"type": "string",
"default": "",
"description": "User to assign issue too"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"issue"
]
}
}
},
{
"name": "issueNumber",
"displayName": "Issue Number",
"type": "number",
"default": 0,
"description": "The number of the issue on which to create the comment on",
"required": true,
"displayOptions": {
"show": {
"operation": [
"createComment"
],
"resource": [
"issue"
]
}
}
},
{
"name": "editFields",
"displayName": "Edit Fields",
"type": "collection",
"default": {},
"description": "User to assign issue to",
"displayOptions": {
"show": {
"operation": [
"edit"
],
"resource": [
"issue"
]
}
}
},
{
"name": "lockReason",
"displayName": "Lock Reason",
"type": "options",
"default": "resolved",
"description": "The issue is Off-Topic",
"options": [
{
"name": "Off-Topic",
"value": "off-topic",
"description": "The issue is Off-Topic"
},
{
"name": "Too Heated",
"value": "too heated",
"description": "The discussion is too heated"
},
{
"name": "Resolved",
"value": "resolved",
"description": "The issue got resolved"
},
{
"name": "Spam",
"value": "spam",
"description": "The issue is spam"
}
],
"displayOptions": {
"show": {
"operation": [
"lock"
],
"resource": [
"issue"
]
}
}
},
{
"name": "releaseTag",
"displayName": "Tag",
"type": "string",
"default": "",
"description": "The tag of the release",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"release"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "The name of the issue",
"options": [
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "The name of the issue"
},
{
"name": "body",
"displayName": "Body",
"type": "string",
"default": "",
"description": "The body of the release"
},
{
"name": "draft",
"displayName": "Draft",
"type": "boolean",
"default": false,
"description": "Whether to create a draft (unpublished) release, \"false\" to create a published one"
},
{
"name": "prerelease",
"displayName": "Prerelease",
"type": "boolean",
"default": false,
"description": "Whether to point out that the release is non-production ready"
},
{
"name": "target_commitish",
"displayName": "Target Commitish",
"type": "string",
"default": "",
"description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch(usually master)."
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"release"
]
}
}
},
{
"name": "release_id",
"displayName": "Release ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"get",
"delete",
"update"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 100
},
"displayOptions": {
"show": {
"resource": [
"release"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "getRepositoryIssuesFilters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "Return only issues which are assigned to a specific user",
"options": [
{
"name": "assignee",
"displayName": "Assignee",
"type": "string",
"default": "",
"description": "Return only issues which are assigned to a specific user"
},
{
"name": "creator",
"displayName": "Creator",
"type": "string",
"default": "",
"description": "Return only issues which were created by a specific user"
},
{
"name": "mentioned",
"displayName": "Mentioned",
"type": "string",
"default": "",
"description": "Return only issues in which a specific user was mentioned"
},
{
"name": "labels",
"displayName": "Labels",
"type": "string",
"default": "",
"description": "Return only issues with the given labels. Multiple labels can be separated by comma."
},
{
"name": "since",
"displayName": "Updated Since",
"type": "dateTime",
"default": "",
"description": "Return only issues updated at or after this time"
}
],
"displayOptions": {
"show": {
"operation": [
"getIssues"
],
"resource": [
"repository"
]
}
}
},
{
"name": "getRepositoryPullRequestsFilters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "Returns pull requests with any state",
"displayOptions": {
"show": {
"operation": [
"getPullRequests"
],
"resource": [
"repository"
]
}
}
},
{
"name": "pullRequestNumber",
"displayName": "PR Number",
"type": "number",
"default": 0,
"description": "The number of the pull request",
"required": true,
"displayOptions": {
"show": {
"operation": [
"get",
"update"
],
"resource": [
"review"
]
}
}
},
{
"name": "reviewId",
"displayName": "Review ID",
"type": "string",
"default": "",
"description": "ID of the review",
"required": true,
"displayOptions": {
"show": {
"operation": [
"get",
"update"
],
"resource": [
"review"
]
}
}
},
{
"name": "event",
"displayName": "Event",
"type": "options",
"default": "approve",
"description": "Approve the pull request",
"options": [
{
"name": "Approve",
"value": "approve",
"description": "Approve the pull request"
},
{
"name": "Request Change",
"value": "requestChanges",
"description": "Request code changes"
},
{
"name": "Comment",
"value": "comment",
"description": "Add a comment without approval or change requests"
},
{
"name": "Pending",
"value": "pending",
"description": "You will need to submit the pull request review when you are ready"
}
],
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"review"
]
}
}
},
{
"name": "organization",
"displayName": "Organization",
"type": "string",
"default": "",
"description": "The GitHub organization that the user is being invited to",
"required": true,
"displayOptions": {
"show": {
"operation": [
"invite"
],
"resource": [
"user"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "The email address of the invited user",
"placeholder": "name@email.com",
"required": true,
"displayOptions": {
"show": {
"operation": [
"invite"
],
"resource": [
"user"
]
}
}
}
],
"credentialsConfig": [
{
"name": "githubApi",
"required": true
},
{
"name": "authentication",
"required": false
},
{
"name": "resource",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "operation",
"required": false
},
{
"name": "webhookNotice",
"required": true
},
{
"name": "name",
"required": false
},
{
"name": "repository",
"required": true
},
{
"name": "name",
"required": false
},
{
"name": "workflowId",
"required": true
},
{
"name": "name",
"required": false
},
{
"name": "ref",
"required": true
},
{
"name": "ref",
"required": true
},
{
"name": "inputs",
"required": true
},
{
"name": "branch",
"required": false
},
{
"name": "committer",
"required": false
},
{
"name": "asBinaryProperty",
"required": true
},
{
"name": "title",
"required": true
},
{
"name": "assignees",
"required": false
},
{
"name": "issueNumber",
"required": true
},
{
"name": "body",
"required": false
},
{
"name": "state",
"required": false
},
{
"name": "state_reason",
"required": false
},
{
"name": "title",
"required": false
},
{
"name": "issueNumber",
"required": true
},
{
"name": "releaseTag",
"required": true
},
{
"name": "release_id",
"required": true
},
{
"name": "returnAll",
"required": false
},
{
"name": "sort",
"required": false
},
{
"name": "direction",
"required": false
},
{
"name": "returnAll",
"required": false
},
{
"name": "sort",
"required": false
},
{
"name": "direction",
"required": false
},
{
"name": "pullRequestNumber",
"required": true
},
{
"name": "body",
"required": false
},
{
"name": "body",
"required": true
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}