Skip to main content

GitHub integration

Prerequisites​

Adding GitHub repository access​

You can grant Faheem Code access to specific GitHub repositories:

  1. Click on + Add GitHub Repos in the repository selection dropdown.
  2. Select your organization and choose the specific repositories to grant Faheem Code access to.
Faheem Code permissions
  • Faheem Code requests short-lived tokens (8-hour expiration) with these permissions:
    • Actions: Read and write
    • Commit statuses: Read and write
    • Contents: Read and write
    • Issues: Read and write
    • Metadata: Read-only
    • Pull requests: Read and write
    • Webhooks: Read and write
    • Workflows: Read and write
  • Repository access for a user is granted based on:
    • Permission granted for the repository
    • User's GitHub permissions (owner/collaborator)
  1. Click Install & Authorize.

Modifying repository access​

You can modify GitHub repository access at any time by:

  • Selecting + Add GitHub Repos in the repository selection dropdown or
  • Visiting the Settings > Integrations page and selecting Configure GitHub Repositories

Working with GitHub repos in Faheem Code Cloud​

Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the Open Repository section to select the appropriate repository and branch you'd like Faheem Code to work on. Then click on Launch to start the conversation.

Screenshot: connect repo.

Working on GitHub issues and pull requests using Faheem Code​

To allow Faheem Code to work directly from GitHub directly, you must give Faheem Code access to your repository. Once access is given, you can use Faheem Code by labeling the issue or by tagging @faheem-code.

Working with issues​

On your repository, label an issue with faheemcode or add a message starting with @faheem-code. Faheem Code will:

  1. Comment on the issue to let you know it is working on it.
    • You can click on the link to track the progress on Faheem Code Cloud.
  2. Open a pull request if it determines that the issue has been successfully resolved.
  3. Comment on the issue with a summary of the performed tasks and a link to the PR.

Working with pull requests​

To get Faheem Code to work on pull requests, mention @faheem-code in the comments to:

  • Ask questions
  • Request updates
  • Get code explanations

Next steps​