Categories: Developer Tools

Type: github/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client id	STRING		true
clientSecret	Client secret	STRING		true

Connection Setup

Login to your GitHub account.
Click on your profile icon in the top right corner.
Select Settings from the dropdown menu.
In the left sidebar, click on Developer settings.
In the left sidebar, click on OAuth Apps.
Click on New OAuth App.
Fill in the required fields:
- Application name: Enter a name for your application (e.g., Test App).
- Homepage URL: Provide the homepage URL for your application (e.g., https://www.bytechef.io/).
- Authorization callback URL: Specify the URL where users will be redirected after authorization (e.g., http://127.0.0.1:5173/callback).
Click Register application.
Click on Generate a new client secret.
Copy the Client ID and Client Secret for later use.

Actions

Add Assignees to Issue

Name: addAssigneesToIssue

Adds assignees to the specified issue.

Properties

Name	Label	Type	Description	Required
repository	Repository	STRING		true
issue	Issue Number	STRING Depends On repository	The number of the issue to add assignee to.	true
assignees	Assignees	ARRAY Items [STRING]	The list of assignees to add to the issue.	true

Example JSON Structure

{
  "label" : "Add Assignees to Issue",
  "name" : "addAssigneesToIssue",
  "parameters" : {
    "repository" : "",
    "issue" : "",
    "assignees" : [ "" ]
  },
  "type" : "github/v1/addAssigneesToIssue"
}

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

{
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
}

Find repository name

To find the repository name, click here.

Add Labels to Issue

Name: addLabelsToIssue

Adds labels to the specified issue.

Properties

Name	Label	Type	Description	Required
repository	Repository	STRING		true
issue	Issue Number	STRING Depends On repository	The number of the issue to add labels to.	true
labels	Labels	ARRAY Items [STRING]	The list of labels to add to the issue.	true

Example JSON Structure

{
  "label" : "Add Labels to Issue",
  "name" : "addLabelsToIssue",
  "parameters" : {
    "repository" : "",
    "issue" : "",
    "labels" : [ "" ]
  },
  "type" : "github/v1/addLabelsToIssue"
}

Properties

Name	Type	Description
id	STRING	ID of the label
name	STRING	Name of the label.
description	STRING	Description of the label.
color	STRING	The hexadecimal color code for the label, without the leading #.

Output Example

[ {
  "id" : "",
  "name" : "",
  "description" : "",
  "color" : ""
} ]

Find repository name

To find the repository name, click here.

Create Comment on Issue

Name: createCommentOnIssue

Adds a comment to the specified issue.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository where the issue is located.	true
issue	Issue Number	STRING Depends On repository, owner	The number of the issue to comment on.	true
body	Comment	STRING	The comment to add to the issue.	true

Example JSON Structure

{
  "label" : "Create Comment on Issue",
  "name" : "createCommentOnIssue",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "issue" : "",
    "body" : ""
  },
  "type" : "github/v1/createCommentOnIssue"
}

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

{
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Create Fork

Name: createFork

Create a fork of Github repository.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository that will be forked.	true
name	Name	STRING	A new name for the fork.	false
organization	Organization	STRING	The organization name if forking into an organization.	false
defaultBranchOnly	Default Branch Only	BOOLEAN Options true, false	When forking from an existing repository, fork with only the default branch.	false

Example JSON Structure

{
  "label" : "Create Fork",
  "name" : "createFork",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "name" : "",
    "organization" : "",
    "defaultBranchOnly" : false
  },
  "type" : "github/v1/createFork"
}

Properties

Name	Type	Description
id	STRING	The unique identifier of the fork.
node_id	STRING	The node ID of the fork.
name	STRING	The name of the forked repository.
full_name	STRING	The full name of the forked repository including owner.
owner	OBJECT Properties {STRING(login), STRING(id), STRING(node_id), STRING(url)}	Owner information.
private	BOOLEAN Options true, false	Indicates if the forked repository is private.
html_url	STRING	HTML URL of the forked repository.
url	STRING	API URL of the forked repository.
description	STRING	Description of the repository.
fork	STRING	Whether this repository is a fork.
created_at	STRING	Creation timestamp.
updated_at	STRING	Last update timestamp.
pushed_at	STRING	Last push timestamp.
default_branch	STRING	Default branch name.

Output Example

{
  "id" : "",
  "node_id" : "",
  "name" : "",
  "full_name" : "",
  "owner" : {
    "login" : "",
    "id" : "",
    "node_id" : "",
    "url" : ""
  },
  "private" : false,
  "html_url" : "",
  "url" : "",
  "description" : "",
  "fork" : "",
  "created_at" : "",
  "updated_at" : "",
  "pushed_at" : "",
  "default_branch" : ""
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Create Issue

Name: createIssue

Create Issue in GitHub Repository

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository where new issue will be created.	true
title	Title	STRING	Title of the issue.	false
body	Description	STRING	The description of the issue.	false

Example JSON Structure

{
  "label" : "Create Issue",
  "name" : "createIssue",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "title" : "",
    "body" : ""
  },
  "type" : "github/v1/createIssue"
}

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

{
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Create Pull Request

Name: createPullRequest

Creates a new pull request.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository where new pull request will be created.	true
title	Title	STRING	Title of the new pull request.	false
body	Body	STRING	The contents of the pull request.	false
head	Head	STRING	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.	true
head_repo	Head Repo	STRING	The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.	false
base	Base	STRING	The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.	true
issue	Issue	INTEGER	An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.	false
draft	Draft	BOOLEAN Options true, false	Indicates whether the pull request is a draft.	true

Example JSON Structure

{
  "label" : "Create Pull Request",
  "name" : "createPullRequest",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "title" : "",
    "body" : "",
    "head" : "",
    "head_repo" : "",
    "base" : "",
    "issue" : 1,
    "draft" : false
  },
  "type" : "github/v1/createPullRequest"
}

Properties

Name	Type	Description
url	STRING	The URL of the created pull request.
id	INTEGER	ID of the created pull request.
node_id	STRING
html_url	STRING
diff_url	STRING
patch_url	STRING
issue_url	STRING
commits_url	STRING
review_comment_url	STRING
comments_url	STRING
statuses_url	STRING
number	INTEGER	Number uniquely identifying the pull request within its repository.
state	STRING	The state of the pull request. Either open or closed.
locked	BOOLEAN Options true, false
title	STRING	The title of the pull request.
user	OBJECT Properties {STRING(login), STRING(id), STRING(html_url), STRING(type)}	A GitHub user.
body	STRING	The contents of the pull request.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]
comments	INTEGER	The number of comments on the pull request.
review_comments	INTEGER	The number of comments for review on the pull request.
maintainer_can_modify	BOOLEAN Options true, false	Indicates whether maintainers can modify the pull request.
commits	INTEGER	The number of commits in the pull request.
additions	INTEGER	The number of additions in the pull request.
deletions	INTEGER	The number of deletions in the pull request.
changed_files	INTEGER	The number of changed files in the pull request.

Output Example

{
  "url" : "",
  "id" : 1,
  "node_id" : "",
  "html_url" : "",
  "diff_url" : "",
  "patch_url" : "",
  "issue_url" : "",
  "commits_url" : "",
  "review_comment_url" : "",
  "comments_url" : "",
  "statuses_url" : "",
  "number" : 1,
  "state" : "",
  "locked" : false,
  "title" : "",
  "user" : {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  },
  "body" : "",
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "comments" : 1,
  "review_comments" : 1,
  "maintainer_can_modify" : false,
  "commits" : 1,
  "additions" : 1,
  "deletions" : 1,
  "changed_files" : 1
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Get Issue

Name: getIssue

Get information from a specific issue

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository where the issue is located.	true
issue	Issue Number	STRING Depends On repository, owner	The number of the issue you want to get details from.	true

Example JSON Structure

{
  "label" : "Get Issue",
  "name" : "getIssue",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "issue" : ""
  },
  "type" : "github/v1/getIssue"
}

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

{
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Gets the contents of a file or directory in a repository. If the content is a directory, the response will be each item in the directory and if the content is a file, the response will be file as a string.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	Repository where the content is located.	true
path	Path	STRING	Path to the file or the directory.	true

Example JSON Structure

{
  "label" : "Get Repository Content",
  "name" : "getRepositoryContent",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "path" : ""
  },
  "type" : "github/v1/getRepositoryContent"
}

Output

Type: STRING

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Find path

To find the path, click here.

List Issues

Name: listIssues

Retrieve issues assigned to the authenticated user across all accessible repositories.

Properties

Name	Label	Type	Description	Required
filter	Filter	STRING Options assigned, created, mentioned, subscribed, repos, all	Specifies the types of issues to return.	true
state	State	STRING Options open, closed, all	Indicates the state of the issues to return.	true

Example JSON Structure

{
  "label" : "List Issues",
  "name" : "listIssues",
  "parameters" : {
    "filter" : "",
    "state" : ""
  },
  "type" : "github/v1/listIssues"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

[ {
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
} ]

List Repository Issues

Name: listRepositoryIssues

Lists issues in a repository. Only open issues will be listed.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	The name of the repository	true

Example JSON Structure

{
  "label" : "List Repository Issues",
  "name" : "listRepositoryIssues",
  "parameters" : {
    "owner" : "",
    "repository" : ""
  },
  "type" : "github/v1/listRepositoryIssues"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

[ {
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
} ]

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Search Code

Name: searchCode

Searches the code in repository and returns up to 100 results per page.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	The repository in which to search for matching code.	true
query	Query	STRING	Query of the code in the repository.	true
extension	Extension	STRING	Matches code files with a certain file extension.	false
filename	Filename	STRING	Matches code files with a certain filename.	false
path	Path	STRING	Searches for source code that appears at a specific location in a repository.	false
in	In	STRING Options file, path, file,path	Restricts your search to the contents of the source code file, the file path, or both.	false
page	Page	INTEGER	The page number of the results to fetch.	false
per_page	Per page	INTEGER	The number of results per page (max 100).	false

Example JSON Structure

{
  "label" : "Search Code",
  "name" : "searchCode",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "query" : "",
    "extension" : "",
    "filename" : "",
    "path" : "",
    "in" : "",
    "page" : 1,
    "per_page" : 1
  },
  "type" : "github/v1/searchCode"
}

Output

Type: OBJECT

Properties

Name	Type	Description
total_count	INTEGER	Total number of matching results.
incomplete_results	BOOLEAN Options true, false	Whether the results are incomplete.
items	ARRAY Items [{STRING(name), STRING(path), STRING(sha), STRING(url), STRING(git_url), STRING(html_url), NUMBER(score), {INTEGER(id), STRING(name), STRING(full_name), STRING(html_url), STRING(url)}(repository)}]	List of code search results.

Output Example

{
  "total_count" : 1,
  "incomplete_results" : false,
  "items" : [ {
    "name" : "",
    "path" : "",
    "sha" : "",
    "url" : "",
    "git_url" : "",
    "html_url" : "",
    "score" : 0.0,
    "repository" : {
      "id" : 1,
      "name" : "",
      "full_name" : "",
      "html_url" : "",
      "url" : ""
    }
  } ]
}

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Find path

To find the path, click here.

Star Repository

Name: starRepository

Stars a repository for the authenticated user.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	The name of the repository including owner without the .git extension. The name is not case sensitive.	true

Example JSON Structure

{
  "label" : "Star Repository",
  "name" : "starRepository",
  "parameters" : {
    "owner" : "",
    "repository" : ""
  },
  "type" : "github/v1/starRepository"
}

Output

This action does not produce any output.

Find user or organization

To find the user or organization, click here.

Find repository name

To find the repository name, click here.

Update Issue

Name: updateIssue

Update the details of an existing issue within a specified repository.

Properties

Name	Label	Type	Description	Required
owner	User/Organization	STRING	The owner of the repository (user or organization).	true
repository	Repository	STRING	The repository where issue is located.	true
issue	Issue Number	STRING Depends On repository, owner	The number of the issue you want to update.	true
title	Title	STRING	The new title of the issue.	false
body	Body	STRING	The updated description of the issue.	false
state	State	STRING Options open, closed	The new state of the issue (open/closed).	false
milestone	Milestone	STRING	The number of the milestone to associate this issue with or use null to remove the current milestone.	false
labels	Labels	ARRAY Items [STRING]	A list of labels to associate with this issue.	false
assignees	Assignees	ARRAY Items [STRING]	A list of usernames to assign this issue.	false

Example JSON Structure

{
  "label" : "Update Issue",
  "name" : "updateIssue",
  "parameters" : {
    "owner" : "",
    "repository" : "",
    "issue" : "",
    "title" : "",
    "body" : "",
    "state" : "",
    "milestone" : "",
    "labels" : [ "" ],
    "assignees" : [ "" ]
  },
  "type" : "github/v1/updateIssue"
}

Output

Type: OBJECT

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

Output Example

{
  "url" : "",
  "repository_url" : "",
  "id" : 0.0,
  "number" : 1,
  "title" : "",
  "state" : "",
  "assignees" : [ {
    "login" : "",
    "id" : "",
    "html_url" : "",
    "type" : ""
  } ],
  "labels" : [ {
    "id" : "",
    "name" : "",
    "description" : ""
  } ],
  "body" : ""
}

Find milestone number

To find the milestone number, click here.

Triggers

Events Trigger

Name: eventsTrigger

Triggers on specified events.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
repository	Repository	STRING		true
events	Events	ARRAY Items [STRING]	Determines what events the hook is triggered for.	true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "Events Trigger",
  "name" : "eventsTrigger",
  "parameters" : {
    "repository" : "",
    "events" : [ "" ]
  },
  "type" : "github/v1/eventsTrigger"
}

New Issue

Name: newIssue

Triggers when a new issue is created.

Type: POLLING

Properties

Name	Label	Type	Description	Required
repository	Repository	STRING		true

Output

Type: OBJECT

Properties

Name	Type	Description
url	STRING	The URL linking directly to the issue on GitHub.
repository_url	STRING	The URL of the repository where the issue is located.
id	NUMBER	ID of the issue.
number	INTEGER	A unique number identifying the issue within its repository.
title	STRING	The title or headline of the issue.
state	STRING	The current state of the issue, such as open or closed.
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	A list of users assigned to the issue.
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	A collection of labels associated with the issue.
body	STRING	The main content of the issue.

JSON Example

{
  "label" : "New Issue",
  "name" : "newIssue",
  "parameters" : {
    "repository" : ""
  },
  "type" : "github/v1/newIssue"
}

New Pull Request

Name: newPullRequest

Triggers when a new pull request is created.

Type: POLLING

Properties

Name	Label	Type	Description	Required
repository	Repository	STRING		true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Pull Request",
  "name" : "newPullRequest",
  "parameters" : {
    "repository" : ""
  },
  "type" : "github/v1/newPullRequest"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find your repository name

Go to your repository on GitHub.
Look at the URL in your browser. It will look similar to:

https://github.com/owner/repository
- owner → GitHub username or organization name
- repository → repository name

How to find your issue number

Go to the Issues tab of your repository.
Click on the issue you want.
Look at the URL in your browser. It will look similar to:

https://github.com/owner/repository/issues/45

The number at the end of the URL (45 in this example) is your issue number.

How to find your assignee

Open the issue.
On the right sidebar, locate the Assignees section.
The listed GitHub username(s) are the assignee(s).

How to find labels

Open the issue.
On the right sidebar, locate the Labels section.
The labels listed there are the labels assigned to the issue.
- You can click Labels to view all available labels in the repository.
- Each label may have a color and a name (e.g., bug, enhancement, documentation).

How to find user or organization

Go to your repository on GitHub.
Look at the URL in your browser. It will look similar to:

https://github.com/owner/repository
- owner → GitHub username or organization name

How to find file path

Navigate to the repository on GitHub.
Browse the folders to the file you want.
Look at the URL in your browser. It will have this format:

https://github.com/owner/repository/blob/main/path/to/file.ext
- The part after blob/main/ is the file path:
path/to/file.ext

How to find your milestone number

You have several methods to find your GitHub milestone number:

Method 1: Through the Milestones page URL

Go to your repository on GitHub.
Click on the Issues tab.
Click on Milestones.
Click on the milestone you want.
Look at the URL in your browser. It will look similar to:

https://github.com/owner/repository/milestone/3

The number at the end of the URL (3 in this example) is your milestone number.

Method 2: Through the GitHub API

Open your browser.
Enter the following URL (replace owner and repository with your actual values):

https://api.github.com/repos/owner/repository/milestones
Find your milestone in the JSON response.
The number field next to the milestone name is your milestone number.

GitHub

On this page