Skip to content
Docs
Get Started

Get Started

This guide will help you set up recommit and automate your first cherry-pick workflow in just a few minutes.

Prerequisites

  • A GitHub account
  • One or more repositories with multiple branches (e.g., main, v2, v1)

Quick Setup

Sign in with GitHub

Go to recommit.dev (opens in a new tab) and click Sign in with GitHub.

Authorize recommit to access your GitHub account. We request only the permissions needed to manage cherry-picks.

Sign in page

Install the GitHub App

After signing in, you'll need to install the recommit GitHub App to grant access to your repositories.

  1. Click Install GitHub App in the dashboard
  2. Select the organization or personal account
  3. Choose which repositories to authorize:
    • All repositories - Grants access to all current and future repos
    • Only select repositories - Choose specific repos (recommended)
  4. Click Install to complete

You can modify repository access anytime from your GitHub settings.

Create a Roadmap

A Roadmap defines where your code should be cherry-picked. It's a template for your branch synchronization strategy.

  1. Go to ConsoleRoadmap
  2. Click Create Roadmap
  3. Configure your roadmap:
    • Name: A descriptive name (e.g., "Release Branches")
    • Branches: Target branches separated by space (e.g., main v3 v2 v1)
    • Cherry-pick to Default Branch: Enable if you want all PRs to sync to the default branch

Example configuration for a library with multiple versions:

SettingValue
NameRelease Branches
Branchesmain v3 v2 v1
Cherry-pick to Default Branch✓ Enabled

Link Repository to Roadmap

Now connect your repository to the roadmap:

  1. Go to ConsoleRepositories
  2. Find your repository in the list
  3. Click on the repository to open settings
  4. Select the Roadmap you just created
  5. Toggle Enable to activate auto cherry-pick

Test It Out

Create a test PR and merge it:

  1. Create a new branch from any of your configured branches
  2. Make a small change and open a Pull Request
  3. Merge the PR

recommit will automatically:

  • Detect the merged PR
  • Cherry-pick the changes to all configured branches
  • Create new PRs for each target branch

Check the Cherry-Pick History in your dashboard to see the results.

What's Next?

Need Help?

If you run into any issues, check our FAQ or contact support.