Manage Roadmap
Learn how to update, modify, and delete your roadmap configurations.
Viewing Roadmaps
Navigate to Console → Roadmap to see all your roadmaps.
Each roadmap card displays:
- Name - The roadmap identifier
- Branches - Target branches for cherry-pick
- Linked Repositories - Number of repos using this roadmap
- Default Branch Option - Whether auto-sync to default branch is enabled
Updating a Roadmap
To modify an existing roadmap:
- Go to Console → Roadmap
- Click on the roadmap you want to edit
- Update the desired fields:
- Change the name
- Add or remove branches
- Toggle "Cherry-pick to Default Branch"
- Update the regexp pattern
- Click Save to apply changes
Changes take effect immediately for new PRs. Existing cherry-pick tasks in progress are not affected.
Updating Branches
When modifying the branch list:
Adding a branch:
Before: main; v3; v2
After: main; v3; v2; v1Future PRs will now cherry-pick to v1 as well.
Removing a branch:
Before: main; v3; v2; v1
After: main; v3; v2Future PRs will no longer cherry-pick to v1.
Reordering branches:
Before: v3; v2; v1; main
After: main; v3; v2; v1The processing order will change, but all branches still receive cherry-picks.
Deleting a Roadmap
Warning: You cannot delete a roadmap that has linked repositories. Unlink all repositories first.
Prerequisites for Deletion
Before deleting a roadmap, you must:
- Go to Console → Repositories
- Find all repositories linked to this roadmap
- Unlink each repository (see Unlink Repository)
Delete Process
Once no repositories are linked:
- Go to Console → Roadmap
- Click on the roadmap to delete
- Click Delete Roadmap
- Confirm the deletion
Deletion is permanent. Historical cherry-pick records will be preserved, but the roadmap configuration cannot be recovered.
Best Practices
Naming Conventions
Use descriptive names that reflect the purpose:
| ✅ Good | ❌ Avoid |
|---|---|
Release Branches | Roadmap 1 |
Security Backports | My Config |
v5 LTS Support | Test |
Branch Organization
- Order branches from newest to oldest (e.g.,
main v3 v2 v1) - Keep the list manageable - Remove end-of-life branches
- Cherry-picks flow forward in processing order: a PR merged to v2 will cherry-pick to v3 and main
Multiple Roadmaps
You can create different roadmaps for different purposes:
| Roadmap | Branches | Use Case |
|---|---|---|
Feature Releases | main develop | Regular development |
LTS Support | v3-lts v2-lts | Long-term support |
Hotfixes | main v3 v2 v1 | Critical patches |
Then link different repositories to appropriate roadmaps based on their release strategy.
Troubleshooting
Cannot Delete Roadmap
Error: "Roadmap has linked repositories"
Solution:
- Check which repositories are using this roadmap
- Go to each repository and unlink the roadmap
- Try deleting again
Changes Not Taking Effect
Issue: Updated branches but PRs not cherry-picking to new branch
Check:
- Is the repository still enabled?
- Was the PR merged after the roadmap update?
- Does the new branch exist in the repository?