RoadmapAI
Setup guide · ~3 minutes

How to connect GitHub to RoadmapAI

Install the RoadmapAI GitHub App on your account or organization to turn new issues and discussions into requests, comment back as they move, and close issues when their item ships.

Before you start
  • ✓A RoadmapAI project (the free trial works)
  • ✓Owner or admin access to the GitHub account or organization

Step by step

  1. 1

    Open Integrations in your dashboard

    In RoadmapAI, open Integrations from the sidebar and find the GitHub section.

  2. 2

    Click "Install on GitHub"

    GitHub asks where to install the app. Choose your personal account or the organization that owns your repositories.

  3. 3

    Choose repository access

    Pick "Only select repositories" and choose the public repos your users file issues in, or "All repositories". You can change this later in GitHub settings.

    Tip: Giving access is not the same as reading. RoadmapAI only reads the repositories you tick in the next step.

  4. 4

    Pick the repositories to read

    Back in RoadmapAI, Configure opens. Tick the repositories under "Repositories to read", then choose what to look at: new issues, new discussions, or both. Pull requests and bots are always skipped.

  5. 5

    Filter by label (optional)

    Under "Only issues labeled", add labels like "enhancement" or "feature-request" to read only those issues. An issue that gets the label later is read then.

  6. 6

    Keep issues and the roadmap in step

    Two switches keep both sides in sync:

    • •"Close the issue when the item ships": when the roadmap item reaches Completed, its issues are closed as completed
    • •"Ship the item when the issue is closed": closing an issue as completed on GitHub moves its item to Completed. Issues closed as not planned are left alone
  7. 7

    Set up comments and save

    Choose when RoadmapAI comments on the issue, mentioning its author. Add your teammates under "Ignored users" so their issues are skipped. Click "Save settings".

    Example
    Thanks @dana! This is now on our public roadmap: https://theroadmapai.com/r/acme/webhooks. We'll update this issue when it ships.

Use cases

Open-source projects

Users open issues for everything. RoadmapAI separates feature requests from questions and bugs and gives you a public roadmap your community can vote on.

What happens Issue: "Support for PostgreSQL 17"
What RoadmapAI does Captured as a request. Five similar issues count as five votes on one item.

Ideas in GitHub Discussions

Turn on "New discussions" to read the Ideas category without anyone copying threads over by hand.

What happens Discussion: "Would love a VS Code extension"
What RoadmapAI does Captured as "VS Code extension", with a comment linking to the roadmap item.

Shipping closes the loop

Mark the item Completed and every linked issue is closed with a comment, so nobody has to clean up old issues.

What happens "Webhooks" moves to Completed.
What RoadmapAI does Issues #212, #240 and #301 are closed with "This shipped!"

Troubleshooting

No repositories are listed

The app has no access yet. Use "Give the app access on GitHub" in Configure to add repositories, then refresh.

The account shows "Disconnected"

The app was uninstalled or suspended on GitHub. Click "Reconnect" to install it again, or unsuspend it in your GitHub settings.

Issues from my team are captured

Add their GitHub usernames under "Ignored users" in Configure.