This article will help you:
- Create and work with new branches of your tracking plan
- Merge your work back into the
- Delete an old branch when it's no longer useful to you
When multiple teams make and test changes to a tracking plan at the same time, ensuring they can do this without inadvertently undoing each other’s work can become a challenge. Rather than trying to coordinate these parallel efforts, Amplitude Data lets each team create their own isolated working area called a branch.
If you're familiar with Git, branches in Amplitude Data will be immediately familiar to you. A branch is like a point-in-time snapshot of the tracking plan created for you and your team. You can make your own changes to it without those changes being immediately visible to everyone else, and only merge them back into the main tracking plan when you're ready.
When you first create your Amplitude Data account, a default branch called
main will automatically be created for you. It will include a few sample events and properties to get you started. Think of the
main branch as your production branch: it contains your latest official tracking plan and matches what's currently instrumented in your default branch in Git (typically
main is perfect for getting started in Amplitude Data, and you may find that it's the only branch you need for quite some time.
Publish a version of your tracking plan
Changes you make on a branch (whether on the
main branch or your own branch later on) are initially kept in the branch's staging area, where they remain pending. Pending changes are like work-in-progress changes: visible to you and your teammates, but hidden from your production systems and not yet available for instrumentation by your engineering team.
When your pending changes are ready to go, you'll publish them. Publishing your changes creates a new version of your tracking plan in which those changes are applied. It also exposes that new version to your engineering team for instrumentation. If your new version was created on the main branch, those changes will also propagate to your production systems.
Every new version is assigned a version number and an optional description, so you can tell them apart later. Version numbers start at 1 and increment by 1 each time you publish a new one.
Every branch has its own tracking plan versions, which means it's possible you'll have two versions of the tracking plan with the same version number: one in
main, and one in your own branch. When this happens, Amplitude Data will always display the name of the branch, to avoid any confusion.
Mind your environment
You can make modifications to your tracking plan in any filtered environment—Production, Development, or Staging—or an environment further segmented by status and filters, as seen in the below image. It's important to understand which changes will or won't sustain when working in environments where the action wasn't taken.
Any creation, update or deletion to events, properties, or groups will apply to all environments that the object is present in. All other actions, like blocking or transformations, are environment-specific.
The following table highlights actions that will sustain across all environments versus solely the filtered environment in which the action was performed.
Actions that will sustain across all environments are:
- Creating events, properties, or groups
- Updating events, properties, or groups (includes visibility and activity status changes)
- Deleting events, properties, or groups
Actions that will sustain only in the filtered environment in which the action was performed are:
- Applying block or drop filters
- Blocking events, properties, or groups
- Any action involving custom events
- Any action involving derived properties
- Any action involving lookup properties
- Any action involving transformations
NOTE: The branch and settings you're working with dictate how changes are saved, approved, or merged. For example, changes allowed on a
main branch depend on your settings but are automatically applied when saved. Read more about working with branches.
Create and delete branches
As you and your team ramp up your use of Amplitude Data, you may outgrow the
main branch and find yourselves in need of a more robust workflow. This usually happens when:
Too many people are making changes to
mainat the same time; or
Feature teams would like their own separate copy of the tracking plan to collaborate in, review their work, and get stakeholder approval
In Amplitude Data, all branches are created off
main and merge back into
To create a new branch, follow these steps:
Click main in the page's header.
Type in the name of the branch you'd like to create.
- In the Create branch modal, confirm the name of your branch, add an optional description, and click Create.
If you had any pending changes on
main, you'll have a chance to either take those changes with you into your new branch, or leave them behind on
Click next to the branch name to delete a branch.
In the modal that appears, click Delete to confirm your choice.
Work on a branch
Once your branch is created, working with it is just like working with
main. You and your team will create and publish new versions on it, instrument those versions in the product, and report back to the branch on the status of the instrumentation.
All of this can happen in parallel with other teams working in their own branches without any impact on you.
From time to time, you'll refresh your branch with any changes that may have been made to
main since you created your branch. If Amplitude Data detects that your branch is out of date with
main, you’ll see a Refresh button in the page's toolbar. Click it to get caught up.
Merge your branch back into main
When you’re happy with the changes you've made on your branch, it’s time to merge them back into
main. This typically happens when your product team is also ready to merge their changes into the
main branch in Git.
There are a few prerequisites you’ll need to address before you can successfully merge:
All pending changes must be published on your branch.
Your branch must be up to date with
mainmust have all its pending changes published as well.
To publish your changes to a new version on your branch, follow these steps:
In the left-hand sidebar, click Save changes.
In the Save changes modal, review the pending changes. If everything looks correct, click Save.
Then to merge, follow these steps:
Navigate to Activity. You may have to click Refresh.
If your account is configured for team reviews, you may not have permission to merge directly and will instead first create a merge request. A merge request is a way to ask stakeholders outside your team to review your changes and give their explicit approval. Only team members with Manager or Admin permissions can approve changes; do so by logging into Amplitude Data and clicking Merge, in the page's toolbar.
An approved merge request is now ready to be merged by anyone on your team.