- GitHub
- Getting Started with GitHub
- Connecting GitHub to Boost.space Integrator
- Triggers
- Actions
- Create an Issue
- Update an Issue
- Search for an Issue
- Get an Issue
- Add Assignees
- Remove Assignees
- Add Labels to an Issue
- Remove a Label from an Issue
- Create a Release
- Update a Release
- Delete a Release
- Create a Milestone
- Update a Milestone
- Delete a Milestone
- Create or Edit a File
- Delete a File
- Get a File
- Create a Gist
- Update a Gist
- Delete a Gist
- Create a Comment
- List Comments
- Iterators
| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your connection. |
The GitHub integrator. Designed to work with data inside the application.']module[/tooltip]s allow you to watch, create, update, list, retrieve, and delete the assignees, labels, comments, issues, milestones, releases, and gist files in your GitHub account.
Prerequisites
-
A GitHub account
In order to use GitHub with Boost.space Integrator, it is necessary to have a GitHub account. If you do not have one, you can create a GitHub account at github.com.
![[Caution]](https://docs.boost.space/wp-content/uploads/2022/11/caution.png) |
Caution |
|---|---|
|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
1. Go to Boost.space Integrator and open the GitHub module’s Create a connection dialog.
2. Enter a name for the connection and click Continue.
3. Enter your account login credentials and confirm the access by clicking Authorize Boost.space Integrator.
The connection has been established.
See Connecting to GitHub webhook using Boost.space Integrator for adding the webhooks in your GitHub account.
Triggers when a new comment is added or an existing comment is modified.
|
|
|
|
|
Set the maximum number of comments Boost.space Integrator should return during one scenario execution cycle. |
|
|
Select the comments you want to watch:
|
Triggers when a new comment is created.
|
|
Enter a name for the webhook. |
|
|
|
|
|
Set the maximum number of comments Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new fork is created.
|
|
|
|
|
Set the maximum number of forks Boost.space Integrator will work with during one cycle. |
Triggers when a new gist is added or an existing gist is modified.
|
|
|
|
|
Set the maximum number of gists Boost.space Integrator should return during one scenario execution cycle. |
|
|
Select the gists you want to watch:
|
Triggers when a new issue is added or an existing issue is modified.
|
|
|
|
|
Set the maximum number of issues Boost.space Integrator should return during one scenario execution cycle. |
|
|
Select the issues you want to watch:
|
|
|
Select the option to filter the results:
|
|
|
Select the issue status you want to watch:
|
|
|
Add the tags of the issues you want to watch. |
Triggers when an issue is assigned, unassigned, labeled, unlabeled, opened, closed, or reopened.
|
|
Enter a name for the webhook. |
|
|
|
|
|
Set the maximum number of issues for events Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new milestone is added or an existing milestone is modified.
|
|
|
|
|
Set the maximum number of milestones Boost.space Integrator will work with during one cycle. |
|
|
Select the milestones you want to watch:
|
|
|
Select the status of the milestone you want to watch:
|
Triggers when a new pull request is added or an existing pull request is modified.
|
|
Enter a name for the webhook. |
|
|
|
|
|
Set the maximum number of pull requests Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new push occurs.
|
|
Enter a name for the webhook. |
|
|
|
|
|
Set the maximum number of push actions Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new release is created.
|
|
Enter a name for the webhook. |
|
|
|
|
|
Set the maximum number of releases Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new repository is added or an existing repository is modified.
|
|
|
|
|
Set the maximum number of repositories Boost.space Integrator will work with during one cycle. |
|
|
Select the repositories you want to watch:
|
Creates a new issue.
|
|
|
|
|
Select the repository in which you want to create the issue. |
|
|
Select the assignee for the issue. |
|
|
Select the milestone applicable for the issue. |
|
|
Add the tags for the issue. For example, |
|
|
Enter a name for the issue. |
|
|
Enter the issue details. |
Updates an existing issue.
|
|
|
|
|
Select the repository in which you want to create the issue. |
|
|
Select the assignee for the issue. |
|
|
Select the milestone applicable for the issue. |
|
|
Add the tags for the issue. For example, bug, enhancement |
|
|
Enter the issue number. |
|
|
Select the issue status:
|
|
|
Enter a name for the issue. |
|
|
Enter the issue details. |
Returns the information of an issue.
|
|
|
|
|
Set the maximum number of issues Boost.space Integrator should return during one scenario execution cycle. |
|
|
Select the option to sort the issues:
|
|
|
Select the order in which you want to list the issues:
|
|
|
Enter a keyword or phrase to search the issues based on the specified query. |
Retrieves information about an issue.
|
|
|
|
|
Select the repository whose issue details you want to retrieve. |
|
|
Enter the issue number whose details you want to retrieve. |
Adds the assignees to an issue.
|
|
|
|
|
Select the repository to whose issue you want to add the assignee. |
|
|
Select the assignees you want to add to the issue. |
|
|
Enter the issue number to which you want to add the assignee. |
Removes assignees from an issue.
|
|
|
|
|
Select the repository whose issue’s assignee you want to remove. |
|
|
Select the assignees you want to remove from the issue. |
|
|
Enter the issue number from which you want to remove the assignee. |
Adds a label to an Issue
|
|
|
|
|
Select the repository to whose issue you want to add a label. |
|
|
Add the labels you want to add an issue. For example, |
|
|
Enter the issue number to which you want to add the labels. |
Removes a label from an issue.
|
|
|
|
|
Select the repository whose issue’s labels you want to remove. |
|
|
Add the labels you want to remove from an issue. For example, |
|
|
Enter the issue number from which you want to remove the labels. |
Creates a new release.
|
|
|
|
|
Select the repository in which you want to add the release. |
|
|
Add the tags for the release. |
|
|
Specifies the location to commit the release and determines where the Git tag is created from. It can be any branch or commit SHA. Unused if the Git tag already exists. By default, the repository’s default branch is the master. |
|
|
Enter a name for the release. |
|
|
Enter the details of the release. |
|
|
Select whether the release is in a draft stage. |
|
|
Select whether this release eligible for a prerelease. |
Updates an existing release.
|
|
|
|
|
Select the repository whose release details you want to update. |
|
|
Select the Release ID whose details you want to update. |
|
|
Add the tags for the release. |
|
|
Specifies the location to commit the release and determines where the Git tag is created from. It can be any branch or commit SHA. Unused if the Git tag already exists. By default, the repository’s default branch is the master. |
|
|
Enter a name for the release. |
|
|
Enter the details of the release. |
|
|
Select whether the release is in a draft stage. |
|
|
Select whether this release eligible for a prerelease. |
Deletes an existing release.
|
|
|
|
|
Select the repository whose release details you want to delete. |
|
|
Select the Release ID you want to delete. |
Creates a new milestone.
|
|
|
|
|
Select the repository in which you want to create the milestone. |
|
|
Enter a name for the milestone. |
|
|
Enter the details of the milestone. |
|
|
Enter a date on which the milestone is due. See the list of supported data formats. |
Updates an existing milestone.
|
|
|
|
|
Select the repository whose milestone’s details you want to update. |
|
|
Enter the milestone number whose details you want to update. |
|
|
Enter a name for the milestone. |
|
|
Select the milestone status:
|
|
|
Enter the details of the milestone. |
|
|
Enter a date on which the milestone is due. See the list of supported data formats. |
Deletes an existing milestone.
|
|
|
|
|
Select the repository whose milestone’s details you want to delete. |
|
|
Enter the milestone number you want to delete. |
Creates a new or updates an existing file.
|
|
|
|
|
Select the repository whose file you want to create or update. |
|
|
Enter the path address of the file. |
|
|
Enter details of the file. |
|
|
Enter the file data. |
|
|
Enter the SHA details of the file. This field is mandatory to update an existing file. |
|
|
Enter the branch details where you are creating or updating the file. |
Deletes an existing file.
|
|
|
|
|
Select the repository whose file you want to delete. |
|
|
Enter the path address of the file you want to delete. |
|
|
Enter details of the file. |
|
|
Enter the file data. |
|
|
Enter the SHA details of the file. This field is mandatory to update an existing file. |
|
|
Enter the branch details of the file you want to delete. |
Retrieves the information about the specified file.
|
|
|
|
|
Select the repository whose file you want to delete. |
|
|
Enter the path address of the file whose details you want to retrieve. |
|
|
Enter the tag, branch, or commit details of the file you want to retrieve. |
Creates a new gist.
|
|
|
|
|
Add the file name and content to make a gist. |
|
|
Select the checkbox if this gist is public. |
|
|
Enter the details of the gist. |
Updates an existing gist.
|
|
|
|
|
Select the Gist ID whose details you want to update. |
|
|
Add the file name and content to make a gist. |
|
|
Select whether this gist is public. |
|
|
Enter the details of the gist. |
Deletes an existing gist.
|
|
|
|
|
Select the Gist ID you want to delete. |
Creates a new comment for an issue.
|
|
|
|
|
Select the repository in which you want to create the comment. |
|
|
Enter the issue, milestone, or gist number for which you want to add the comment. |
|
|
Enter the comment text. |
Lists comments for an issue.
|
|
|
|
|
Select the repository whose comments you want to list. |
|
|
Enter the issue, milestone, or gist number whose comments you want to list. |
|
|
Enter the date to list the comments added on or after the specified date. |
|
|
Set the maximum number of comments Boost.space Integrator should return during one scenario execution cycle. |
Retrieves files from a gist one at a time.
The GitHub retrieves files from only the Watch Gists module. The module iterates the received Gists details one by one.
The iterator module lets you manage the email attachments separately. For example, you can set up to Watch Gists module to iterate the Gists with its details.
For more information about iterators, see Iterator.
1. Open any Watch Module, establish a connection as mentioned in the respective module description, click Save, and copy the URL address to your clipboard.
2. Log in to your GitHub account and open the repository in which you want to add the webhook.
3. Click Settings > Webhooks > Add webhook and enter the details to add the webhook.
|
|
Enter the URL address copied in step 1. |
|
|
Select the content type as |
|
|
Enter the repository secret details. To create a secret, open the Repository > Settings > Secret. Enter the name and value of the secret. Click Add Secret. |
|
|
Select the events for which you want to receive the trigger:
|
|
|
Select the checkbox to activate the webhook. |
4. Click Add Webhook.
The webhook is added successfully.
Do you need help with something specific regarding GitHub?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch