GitHub Integrations Guide

Knowledge Base > Guides > Integrations > GitHub

Seamlessly connect Your App Name with GitHub to streamline your development workflow. This guide will walk you through setting up and utilizing the GitHub integration.

Why Integrate with GitHub?

• Automated Workflow Triggers: Automatically update Your App Name based on GitHub events like pull requests, commits, and branch merges.
• Centralized Information: Link your Your App Name projects and tasks directly to your code repositories for better context.
• Enhanced Collaboration: Share code updates and project status effortlessly between Your App Name and your development team on GitHub.
• Code Review Insights: Gain visibility into code review status and discussions directly within Your App Name.

Setting Up the GitHub Integration

1. Prerequisites

• An active Your App Name account.
• A GitHub account with appropriate permissions for the repositories you wish to integrate.

2. Connecting Your GitHub Account

1. Navigate to the Integrations section in your Your App Name settings.
2. Click on the "Add Integration" button and select GitHub.
3. You will be redirected to GitHub to authorize the connection. Review the requested permissions and click "Authorize".
4. Once authorized, you will be redirected back to Your App Name, and your GitHub account will be connected.

3. Configuring Repository Access

After connecting your account, you'll need to specify which repositories Your App Name should have access to:

• In the GitHub integration settings within Your App Name, you can choose to grant access to:
  • All Repositories: Grants access to all repositories in your GitHub account.
  • Specific Repositories: Allows you to select individual repositories.
• Click "Save Changes" after making your selections.

Using the GitHub Integration

Automating Workflow Triggers

You can set up automated actions in Your App Name based on events from your GitHub repositories. For example:

• On new commit: Automatically create a task or update a status in Your App Name.
• On pull request opened: Link the PR to a specific task and notify relevant team members.
• On pull request merged: Close associated tasks or trigger a deployment process.

Linking Code to Tasks

When creating or editing a task in Your App Name, you can easily link it to a specific GitHub commit or pull request:

1. In the task details, look for the "GitHub Link" field.
2. Enter the URL of the GitHub commit, branch, or pull request.
3. Your App Name will display a preview or a direct link to the specified GitHub resource.

Example: Creating a task from a GitHub issue

Let's say you want to turn a GitHub issue into a task in Your App Name. You can set up a webhook or a manual process:

Manual Linking:

1. Copy the URL of the GitHub issue.
2. Create a new task in Your App Name.
3. Paste the GitHub issue URL into the "GitHub Link" field.

Automated (using webhooks - requires advanced setup):

You can configure a GitHub webhook to send a notification to Your App Name's API endpoint whenever an issue is created. Your App Name can then automatically create a task.

// Example webhook payload snippet (simplified)
{
  "action": "opened",
  "issue": {
    "title": "Bug in user authentication",
    "html_url": "https://github.com/your-org/your-repo/issues/123",
    "body": "Users are unable to log in...",
    "user": {
      "login": "github_user"
    }
  },
  "repository": {
    "full_name": "your-org/your-repo"
  }
}

Troubleshooting Common Issues

• Connection Failed: Ensure you have granted the necessary permissions during the authorization process. Try disconnecting and reconnecting the integration.
• No Repositories Listed: Verify that your GitHub account has access to the repositories you expect to see. Check repository visibility settings (public/private).
• Webhooks Not Firing: Double-check the webhook URL in your GitHub repository settings and ensure it points to the correct Your App Name endpoint. Verify that the correct events are selected for the webhook.