Skip to content
Docs
Repositories
Enable Repository

Enable Repository

Enabling a repository activates automatic cherry-picking. When a PR is merged, recommit will automatically cherry-pick the changes to all branches defined in the linked roadmap.

Prerequisites

Before enabling a repository, ensure:

  1. ✅ Repository is imported (via GitHub App installation)
  2. ✅ A Roadmap has been created
  3. ✅ Repository is linked to the Roadmap
  4. ✅ Your organization has an active subscription

How to Enable

Open Repository Settings

  1. Go to ConsoleRepositories
  2. Find and click on the repository you want to enable

Link a Roadmap (if not already linked)

If the repository doesn't have a roadmap linked:

  1. Click the Roadmap dropdown
  2. Select the appropriate roadmap
  3. The link is saved automatically

Toggle Enable Switch

  1. Find the Enable toggle switch
  2. Click to turn it ON
  3. The repository is now active

What Happens When Enabled

Once enabled, recommit will:

  1. Listen for PR events via GitHub webhooks
  2. Detect merged PRs on any branch
  3. Execute cherry-picks to all roadmap branches
  4. Create new PRs on each target branch

Only merged PRs trigger cherry-picks. Closed (unmerged) PRs are ignored.

Disabling a Repository

To temporarily stop auto cherry-picking:

  1. Go to ConsoleRepositories
  2. Click on the repository
  3. Toggle Enable to OFF

When disabled:

  • No new cherry-picks will be triggered
  • Existing in-progress cherry-picks will complete
  • Historical records are preserved
  • You can re-enable anytime

Common Use Cases

Temporary Pause

Need to pause cherry-picks during a release freeze?

  1. Disable the repository
  2. Complete your release process
  3. Re-enable when ready

Testing Configuration

Want to test your roadmap setup safely?

  1. Create a test branch
  2. Enable the repository
  3. Merge a small test PR
  4. Verify cherry-picks worked correctly
  5. Adjust roadmap if needed

Emergency Stop

If cherry-picks are causing issues:

  1. Disable the repository immediately
  2. Investigate the problem
  3. Fix any conflicts or misconfigurations
  4. Re-enable when resolved

Troubleshooting

Repository Won't Enable

Check these common issues:

IssueSolution
No roadmap linkedLink a roadmap first
Subscription expiredRenew your subscription
GitHub App suspendedCheck GitHub App settings

Enabled But No Cherry-Picks

Verify the following:

  1. PR was merged (not just closed)
  2. Target branch exists in roadmap
  3. Repository status is "Normal"
  4. Check Cherry-Pick History for errors

Status Shows "Suspended"

This means the GitHub App access was suspended:

  1. Go to GitHub → Settings → Applications
  2. Find recommit app
  3. Check if it's suspended
  4. Re-authorize if needed

Best Practices

Start with Test Repos

Before enabling important repositories:

  1. Test with a less critical repository
  2. Verify the workflow works as expected
  3. Then enable production repositories

Monitor Initial Cherry-Picks

After enabling:

  1. Merge a test PR
  2. Watch the cherry-pick history
  3. Verify PRs are created correctly

Keep Roadmap Updated

Regularly review your roadmap:

  1. Remove end-of-life branches
  2. Add new release branches
  3. Update branch order if priorities change

Related