This page assumes that your project has already been set up for version control. If you see a Configure Git button instead of the choices described on this page, you need to first set up Git for your project.
Git Integration for Version Control
Looker uses Git to record changes and manage file versions. Each LookML project corresponds with a Git repository, and each developer branch correlates to a Git branch. Git repositories are often called “repos.”
Looker generally uses GitHub for LookML source file management. However, Looker also can be configured to work with other Git providers such as GitLab, Bitbucket, or any Git server that can use an SSH key for authentication.
A Looker project uses only one account with your Git provider for all Git interactions (see this page for information on setting up Git). For each Looker project, all of the development from all of your Looker developers goes through this one Git account. This means that Looker developers do not need to have their own accounts with your Git provider, unless your Looker instance is set up with one of the additional Git integration options. In this case, a Looker developer would need a Git account to open external links to your Git provider or to create a pull request.
Working with Git Branches
One of the main benefits of Git is that a Looker developer can work in a branch, an isolated version of a file repository. You can develop and test without affecting other users. As a developer in Looker, you are using a Git branch whenever you are in Development Mode.
Another major feature of Git is the ease of collaborating with other developers. You can create a branch and possibly make changes, then other developers can switch to that branch to review or make changes to the branch. If another developer has committed changes to the branch, Looker displays the Pull Remote Changes button. You should pull those committed changes to the branch before making additional changes.
The first time you go into Development Mode, Looker automatically creates your personal Git branch. Your personal branch starts with
"dev-" and includes your name:
Your personal branch is specific to you, and cannot be deleted. In addition, your personal branch is read-only to all other developers. Keep this in mind if you are collaborating with other developers on a project. Instead of using your personal branch to work on the project, you may want to create a new branch so that others can switch to the branch and contribute changes as well.
TIP: You can’t make changes to another developer’s personal branch. So if you want to build on work in somebody’s personal branch, create a new branch starting from their branch.
Creating a New Git Branch
If you are working on a simple fix and not collaborating with other developers, your personal branch is usually a good place to work. You can use your personal branch to make quick updates, then commit the changes and push them to production.
However, you may also want to create new Git branches in addition to your personal branch. A new Git branch makes sense in these situations:
- You are working with other developers. Since your personal branch is read-only to other developers, if you want to collaborate with others, you should create a new Git branch so that other developers can write to the branch. When collaborating with others, be sure to pull changes each time you resume work. That way, you’ll have the latest updates from all developers before continuing work.
- You are working on multiple sets of features at once. Sometimes you may be in the middle of a major project, but want to resolve a minor issue or a quick fix. In this case, you can commit your changes to the branch you’re on, then create or switch to another branch to work on a separate set of features. You can make your fix in the new branch, and then deploy that branch’s changes to production—before resuming work in your original branch.
If you have a merge conflict on your current branch, you must resolve the conflict before you can create a new branch.
Also, if you want to create a new branch but have uncommitted changes on your current branch, decide whether those changes should be part of the current branch or the new one. If you want the changes to stay on your current branch, commit the changes before creating a new branch. Otherwise, you can leave the changes uncommitted, create a new branch, then commit the changes in the new branch.
To create a new Git branch:
- Verify that you have Development Mode turned on.
- Navigate to your project in the Develop menu.
- Typically you’ll want to start from the production branch for your new branch. If instead you want to start from an existing development branch, you’ll need to ensure that you have a copy of all committed changes to that branch. To do this, sync your local version of the existing branch with the remote version on your Git server:
- Switch to that development branch.
- Click the Pull Remote Changes option to sync your local version of that branch.
- In the project, select New Branch from the Git drop-down menu. This opens the New Branch window.
- In the New Branch window, enter a name for your branch. Note that there are limitations for Git branch names, see this section for naming requirements.
- Click the Create From drop-down menu and select an existing branch to use as the starting point for your new branch.
- Click Create to create your branch.
Rules for Naming a Git Branch
Looker uses the branch naming convention requirements specified by Git.
Git branch names must not:
- Contain a space character
- Contain a double period: “
- Contain a backslash: “
- Contain the sequence “
- Contain a question mark: “
- Contain an opening square bracket: “
- Contain an ASCII control character: “
~” or “
\^” or “
- Begin with a period: “
- Begin with “
dev-”, since that the prefix is reserved for the personal branches of Looker developers.
- End with a forward slash: “
- End with “
In addition, the branch name can only contain an asterisk (“
*”) if the asterisk represents an entire path component (for example, “
foo/*” or “
bar/*/baz”), in which case it is interpreted as a wildcard and not as part of the actual branch name.
Switching to Another Git Branch
If you have a merge conflict on your current branch, you must resolve the conflict before you can switch to a different branch.
Also, if you have uncommitted changes on your current branch, you cannot switch to an existing branch. You can, however, create a new branch from your current branch. When you create a new branch, any uncommitted changes will follow you so you can commit the changes in the new branch.
To switch to a different Git branch:
- In the project, select Switch Branches from the Git drop-down menu to open the Switch Branch window.
- In the Switch Branch window, click the Switch To drop-down menu to select the branch you want to switch to.
- Click Switch to switch to the branch.
Managing Git Branches
The Branch Management tab of the Project Settings page shows a table of all the Git branches for the Looker project. To open the Branch Management tab, select Manage Branches from the Git menu:
The branch table provides the following information about each branch:
- Name: Name of the Git branch. Looker developers’ personal branches start with “
dev-” and include the first and last name of the developer.
Status: The difference between your local version of the branch and the remote version of the branch. The status “3 commits behind” means that your local version of the branch is behind the remote version of the branch by three commits.
The first time you go into Development Mode, Looker syncs your local version of master to the remote version of master. This is the only time that Looker syncs the local and remote versions of master. At that point, the Branch Management tab will show the master branch as being up to date. But from then on, as Looker developers make commits and push their changes to the remote master branch, you will see your local version of the master branch become more and more behind the remote version. But not to worry — Looker doesn’t use your local version of master. Instead, Looker uses the remote master for creating new Git branches. Using the remote version of master ensures that new branches are based on the latest version of master.
- Last Updated: Amount of time since a Looker developer made a commit to the branch.
- Actions: A button to delete the branch, or the reason that the branch is not eligible for deletion.
Deleting Git Branches
From the Branch Management tab you can delete branches that have a Delete button in the table. You cannot delete the following branches:
- The master branch
- Your current branch
- A Looker developer’s personal branch
In the table, these branches don’t have a Delete button. Instead, the Action column of the table shows the reason that the branch can’t be deleted.
You cannot restore a branch once it’s deleted. When you delete a branch, Looker removes your local version of the branch and the remote version of the branch.
However, if the branch was created by another Looker developer, or if other developers have checked out the branch, those developers will still have their local version of the branch. If a Looker developer makes commits to their local version of the branch and pushes it to production, you will once again see a remote version of the branch. This may be handy if you do want to restore the branch. Otherwise, when you delete a branch, all other Looker developers should delete the same branch to ensure it can’t be accidentally resurfaced by someone pushing it to remote.
To delete one or several Git branches from your project:
- From the project, select Manage Branches from the Git drop-down menu.
- Use the checkboxes to select one or more branches, then click Delete Selected Branches.
- Alternatively, use a branch’s Delete button to delete that one branch.
Executing Git Commands in Looker
Looker has a built-in interface that integrates with your Git service. In the LookML IDE, you’ll see a button in the upper left for Git:
The Git button shows different options, depending on where you are in the process of making changes and deploying to your Production Mode. In general, the option shown on the button is the best guide for your next action.
The Git button also has a drop-down menu, from which you can execute additional commands. (The commands available on the drop-down menu depend on where you are in the process of making changes and deploying to your Production Mode.) For example:
If your developer branch is in sync with the production branch, you will see the Up-to-Date with Production message instead of a Git button. In this case, you can still use the Git drop-down menu:
Finally, experienced Git users can access additional options for the Git menu by holding down the shift button while clicking the Git menu:
Getting Your Changes to Production
To give business users access to your changes, you need to commit the changes and then deploy to production. Before committing, you may want to first review the uncommitted changes.
If you see a Configure Git button instead of the choices described in this section, you need to first set up Git for your project.
Viewing Uncommitted Changes
Once you have saved changes to your files, you can review all of your changes before committing them by using the View Uncommitted Changes option from the Git drop-down menu:
In the Uncommitted Changes to Project window, you can see a summary of all of the uncommitted, saved changes in all of the project’s files. For each change, Looker shows the following:
- The name of the file replaced and the name of the file added.
- The name of the file replaced is indicated with “
---”) and the name of the file added (indicated with “
+++”). In many cases this may show different versions of the same file, with revisions identified by
- Deleted files are shown as replacing a null file (
- Added files are shown as replacing a null file (
- The name of the file replaced is indicated with “
- The line number where the change begins.
-101,4 +101,4indicates that at the 101st line in the file, 4 lines were removed and 4 lines were added. A deleted file with 20 lines would show
-1,20 +0,0to indicate that at the first line in the file, 20 lines were removed and replaced by zero lines.
- The text that was updated.
- Deleted lines are displayed in red.
- Added lines are shown in green.
The LookML IDE also has several indicators are always displayed when you are in Development Mode and have uncommitted changes, as described on this page.
After you have made and saved any changes to your LookML project, the IDE may require you to validate your LookML:
Whether this is required depends on your project’s setting for code quality. For more information on the Content Validator, see this documentation page.
If another developer has made changes to the production branch since you last updated your local branch, Looker requires you to pull those updates from the production branch:
Once you save your changes (and fix any LookML warnings or errors, if required by your project’s code quality setting and pull from production (if required), the Git button displays the following message:
If desired, you can first review your uncommitted changes before committing.
When you are ready to commit the changes, use the Commit Changes button to commit these changes to your current branch. The following window displays, listing the files that have been added, changed, or deleted.
Enter a message that briefly describes your changes and uncheck any files you don’t want included in the sync. Then click Commit to commit the changes.
Deploying to Production
Once you have committed changes to your project, the IDE will display the Deploy to Production button so that you can push your committed changes to the Production Mode for other users to see.
If your project is configured for Git integration using pull requests, you will see the Open Pull Request button instead of the Deploy to Production button. The Open Pull Request button opens a new browser tab directly to the new pull request page on your Git provider’s website, and automatically fills in the title with the developer’s commit message from Looker.
Checking the Impact of Your Changes
After making your changes available to the organization you can use content validation check to make sure you have not invalidated any dashboards or saved Looks. You’ll have the opportunity to fix them if you have.
Handling Typical Issues
While working on your model, you may need to:
Abandon your changes
Occasionally you may want to abandon your data modeling changes. If they are not yet saved, you can simply refresh or navigate away from the page, then accept the warning prompt. If you have saved them, you can revert the uncommitted changes as described below.
Handle merge conflicts with other developers’ work
If you have more than one developer working on your data model, Git typically handles the situation. However, occasionally Git needs a human to resolve merge conflicts.
Some changes, such as changing the name of a field, can affect existing dashboards and Looks. As mentioned earlier, after making your changes available to the organization you can use content validation to check your content and fix any issues.
Reverting Uncommitted Changes
If you do not want to deploy your saved changes, you can revert all the uncommitted changes for all files in the project or just text changes in a single file.
To revert uncommitted changes for all files, use the Revert Uncommitted Changes option from the Git menu:
To undo the deletion or renaming of a file, you must use this Revert Uncommitted Changes option to revert all uncommitted changes.
To revert any additions or deletions in the contents of a single file, select the Revert Changes option from the file’s gear menu:
Resolving Merge Conflicts
Typically Git can automatically merge your new changes with the production version of your LookML files. A merge conflict occurs when Git has trouble determining which changes to keep. This usually occurs when another developer has made changes since you last pulled and you made changes in the same area. If you have a merge conflict in your code, you will be warned in Looker after you commit changes and pull from production:
When Looker shows the merge conflict warning, it is crucial that you do not push any further changes until you have resolved the merge conflict. Pushing a merge conflict to production will cause parse errors that may prevent exploration of your data.
In the LookML file itself, the lines with conflicts are marked like this:
<<<<<<< HEAD your code ======= production code >>>>>>> branch 'master'
Looker shows the following merge markers to indicate the merge conflicts:
"<<<<<<< HEAD"marks the beginning of the conflicting lines.
">>>>>>> branch 'master'"marks the end of the conflicting lines.
"======="separates each version of the code so you can compare them.
In the example above,
"your code" represents the changes you committed, and
"production code" represents the code that Git could not automatically merge your changes into.
To resolve a merge conflict:
- Find the files with merge conflicts. Looker marks these files with a red exclamation symbol, or you can also search your project for merge markers, such as
HEAD, to find all of the conflicts in your project.
- In the file, go to the lines with merge conflicts.
- Delete the version of the text that you do NOT want to keep, and also delete all of the merge markers.
- Save the file, and repeat the above steps for any other files marked with merge conflicts.
TIP: Search your project for each of the merge markers to verify that you have resolved all conflicts and deleted all of the merge markers. Make sure to remove all instances of merge markers in your LookML files. These markers will cause parse errors that can prevent users from exploring your data.
- After you have resolved all merge conflicts and deleted all merge markers from your project, click on Commit & Resolve Conflict to commit your changes.
- Enter a commit message to describe your changes.
- Click Commit to commit your merge conflict resolution.
- Click Deploy to Production to push all of your changes to production.
Now that you have resolved the merge conflict and pushed your resolution to production, other developers can pull from production and continue work as usual.
Git Garbage Collection
Git garbage collection cleans up unnecessary files and compresses file revisions to optimize your Git repository. Git garbage collection (
git gc) is run automatically when your Looker instance is upgraded or rebooted. To keep from running
git gc too often, Looker waits 30 days since the last
git gc, then runs
git gc on the next reboot.
In rare cases, you might try to Push Changes to Remote or Push Branch to Remote while
git gc is running. If Looker displays an error, wait for a minute or two and then try again to push your changes.