Getting started to implement tracking plan changes in code with Avo codegen

This guide describes how to get started with implementation using Avo Codegen. If your team is not using Codegen yet, we recommend checking out the Implementation Overview page.

Data design on an Avo branch has been finished and it’s time to implement new tracking in code.

Familiarize yourself with the changes

First of all we recommend to open your Avo workspace and navigate to the branch you are about to implement, click View changes in the sidebar to access the diff for the changes in the branch. The diff is split in two, Tracking Plan Changes and Code Changes. The Tracking Plan Changes view is a summary of all changes to the items in the tracking plan and the Code Changes View represents the necessary code changes to start sending data according to the updated tracking plan.

Press View changes button

It’s really valuable to understand what exactly needs to be tracked and clear all unknowns.

We suggest using comments in the code changes view to ask for any clarification before starting to implement.

Read more on the branch changes view.

Pull the new code with Avo CLI

Install the Avo CLI

Install the Avo CLI locally in your project, using NPM or Yarn:

npm install --save-dev avo

pnpm add --save-dev avo

yarn add --dev avo

bun add --dev avo

or globally on your system, using NPM or Yarn:

npm install -g avo

pnpm add -g avo

yarn global add avo

bun add --global avo

Link your project to Avo

Authenticate the Avo CLI with your Avo user:

avo login

Now you can pull your custom tracking snippet from your Avo workspace using Codegen.

avo pull --branch your_branch_name [SourceName]

When you run Avo pull for the first time it will also initialize Avo in your project by adding an avo.json file, containing a pointer to your Avo workspace, source and current branch. This file should be checked into git along with Codegen file.

Implement new events

Now your Avo file will have the changes from the your_branch_name branch. Call all the new Avo Codegen functions in required places, update the new event properties. You can find a reference of all the code snippets required to implement your events in the Codegen tab.

Codegen reference

It might be useful to check the changes tab in your Avo workspace for overview while implementing.

If you are implementing the branch in multiple code bases we recommend you to read the Multiple sources on Avo branches guide.

The most important part

Once you are finished with implementing the code and your source control branch was merged remember to also merge the Avo branch!