GitHub

GitHub is a cloud-based code hosting and version control platform that enables developers to collaborate on projects, track changes, and manage code repositories efficiently. It provides tools for issue tracking, pull requests, CI/CD automation, and secure code storage, making it an essential platform for software development teams.

How to Integrate GitHub with ZBrain Flow

Follow these steps to set up GitHub integration in ZBrain Flow:

1. Click the ‘+’ button in ZBrain Flow.

2. Type "GitHub" in the search bar and select it from the available options.

3. Choose an action to begin the setup process.

How to Create a GitHub Connection in ZBrain Flow

Connection Establishment Steps:

1. Enter a Connection Name: Provide a unique name for easy identification of your GitHub connection.

2. Click 'Connect': Initiate the authentication process.

3. Log in to GitHub: A pop-up window will appear for GitHub authentication.

4. Grant Permissions: Approve the required access permissions for ZBrain Flow.

5. Save the Connection: Click 'Save' to finalize the setup.

Once connected, ZBrain Flow can interact with GitHub to manage repositories, issues, and perform various GitHub-related operations.

Actions Available in ZBrain Flow

1. Create Issue

Enables users to create a new issue in a GitHub repository.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Select the Repository: Choose the specific repository where the issue will be created.

3. Enter the Issue Title: Provide a clear, concise title for the issue.

4. Enter the Issue Description: Add detailed information about the issue.

5. Enter Labels: Specify any relevant labels for the issue.

6. Select Assignee: Choose the team member responsible for the issue.

2. Get Issue Information

Allows users to retrieve detailed information about a specific issue.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Select the Repository: Choose the repository containing the issue.

3. Enter the Issue Number: Specify the unique identifier of the issue to retrieve.

3. Create Comment on an Issue

Enables users to add comments to existing GitHub issues.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Select the Repository: Choose the repository containing the issue.

3. Enter the Issue Number: Specify the unique identifier of the issue.

4. Enter the Comment: Add the text you want to post as a comment.

4. Lock Issue

Allows users to lock a GitHub issue to prevent further comments.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Select the Repository: Choose the repository containing the issue.

3. Enter the Issue Number: Specify the unique identifier of the issue to lock.

4. Select Lock Reason: Choose from available reasons:

   • Off-topic

   • Too heated

   • Resolved

   • Spam

5. Unlock Issue

Enables users to unlock a previously locked GitHub issue.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Select the Repository: Choose the repository containing the issue.

3. Enter the Issue Number: Specify the unique identifier of the issue to unlock.

6. Raw GraphQL Query

Provides advanced users with the ability to execute custom GraphQL queries directly against the GitHub API.

Configuration Steps:

1. Select an Existing Connection or Create a New One: Choose your GitHub connection.

2. Enter the Query: Input your custom GraphQL query.

3. Enter Parameters: Click '+Add Item' to include any required query parameters.

7. Custom API Call

Enables users to send custom API requests to GitHub for advanced operations.

Configuration Steps:

1. Select an Existing Connection or Create a New One

2. Enter the API Endpoint URL – Use a full URL or relative path to the GitHub API base URL.

3. Select the HTTP Method – Choose from the following:

   • GET – Retrieve issue details, repository information, or user data.

   • POST – Create new issues, comments, or repository events.

   • PATCH – Modify issue metadata, repository settings, or labels.

   • PUT – Update existing records.

   • DELETE – Remove issues, comments, or repositories.

   • HEAD – Fetch response headers without retrieving actual data.

4. Add Headers – Define any additional headers required for the API request. Authorization headers are automatically injected. Click '+ Add Item' to include more headers.

5. Add Query Parameters – Customize API requests with query parameters to filter results or specify additional options. Click '+ Add Item' to add more parameters.

6. Enter JSON Body – Provide structured request data in JSON format.

7. Set Timeout (in Seconds) – Define the request timeout duration to prevent long-running API calls from stalling the process.

Note: Click 'f' to insert dynamic values for flexible configurations.