Branchline documentation (public knowledge base)
Set up (5 minutes)
-
Build a tree. Open a company-managed space, Space settings > Component tree. Add top-level components and use Edit > Add a subcomponent, or paste an outline in Import outline:
Platform API Auth Billing Web MobileComponents that already exist at the top level with the same name are moved into place instead of duplicated. Full paths on one line (
Platform > API > Auth) work too. -
Add the Component path field (optional, recommended). A Jira admin creates it once: Jira settings > Work items > Fields > Create field > Component path. Add it to the screens and board card layouts you want.
-
Fill existing work items. Jira settings > Apps > Branchline > Background work > Refresh every path. After that, paths update by themselves when components change.
Search a branch
component in componentBranch("Platform > API"): the API component and everything below it, in every space with a tree. Works without the field.component in componentBranch("Auth", "BLW, BLM"): a single name matches anywhere in the tree; the second argument narrows to spaces.component not in componentBranch("Platform > Legacy"): everything outside a branch."Component path" = "Platform > API": the same with the field, usable on boards, filters, dashboards, subscriptions and exports.
Work items
The Components panel on the work item view shows each component's full path. Choose from the tree opens a searchable tree picker. If your admin turned on "add parents", ticking Auth also adds API and Platform.
Change the tree
Space settings > Component tree > Edit on any row:
- Add a subcomponent, Rename (renames the native component; every path below updates).
- Move under another component, or to the top level.
- Merge into another component: Jira moves every work item across and deletes this one.
- Archive: removes the component from Jira's dropdowns. Work items keep its path in the Component path field. Restore it from the Archive tab; Branchline puts it back on every work item that had it.
- Copy to spaces: creates the same tree in other spaces (only what is missing).
Jira needs unique component names within a space. When you add a second "Auth" in another branch, Jira's own name becomes "Web / Auth"; the tree, paths and picker still show "Auth".
Releases across spaces
Apps > Branchline Releases lists every release by name across the spaces you can see. Open one to see progress per space and overall, the unresolved work and combined release notes.
- New release: the same version in every space you pick.
- Edit: one new name or release date for every space.
- Release: release everywhere, optionally moving unresolved work to the next release in each space (created where it doesn't exist).
- Archive, Unarchive, Unrelease.
- Sync: pick the version whose details win; afterwards a change made to any member on its own space's Releases page is copied to the others. You need to administer every space to turn it on.
Every change shows a preview per space first. Lines you can't apply (not an admin, name already used) are explained and skipped; the rest apply as you.
Permissions
- Building the tree: space admins and Jira admins.
- Picking components on a work item: anyone who can edit it.
- Releases: anyone can view; changes need admin rights in each space (Jira checks).
- Settings and Refresh every path: Jira admins.
Limits
- Components exist only in company-managed spaces (a Jira rule). Releases work in every space.
- Trees up to 10 levels; outline imports up to 500 components at a time.
- Archive keeps up to 50,000 work items per component; merge larger ones instead.
- The releases page reads up to 300 spaces.