User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Configuring Project Version Control Settings

This page describes how to configure elements of your project to integrate with Git for version control.

Project Settings

The Project Settings page has additional configuration options for your project. To see this page, open your project and select Project Settings from the Git menu:

On the Configuration tab of the Projects Settings page, you can configure:

Resetting your Git connection will preserve Git history for the master branch. It will also preserve the history of each Looker developer’s personal branch once they sync their dev mode. To preserve history for all branches, see this Help Center article.

On the Branch Management tab of the Projects Settings page, you can see all the Git branches associated with the project.

At the bottom of the Projects Settings page, you also can see your project’s current Git settings:

Git Integration Options

Once you set up your Git connection, Looker will use your Git provider for managing your LookML source files, as described on the Using Version Control and Deploying page. That’s all you need to do to set up your project with source file management and version control. However, you can configure additional options for Looker’s integration with Git using the Git Integration options on the Project Settings page.

In this example, we’re using GitHub, so the window shows GitHub Integration. However, if you are using a different Git provider, Looker will display your Git provider’s name instead.

Here’s what these Git integration options do:

The Pull Requests Recommended and Pull Requests Required options are only shown if you are self-hosting your repository using a Git provider as described in this section.

If you change your Git integration option, click Save Project Settings to save your new setting.

Integrating External Links to Your Git Provider

If you have enabled any of the extra Git integration options (Show Links, Pull Requests Recommended, or Pull Requests Required), Looker provides external links to your Git provider’s interface. These external links open a new browser tab to your Git provider’s site.

To view these external links, your developers must have an account with your Git provider, and must have access to the project’s Git repository.

In the gear menu for each of your LookML files, Looker provides links to your Git provider’s site to view the file, view the Git blame information for the file, and to view the commit history for the file:

In the Git menu, Looker provides a link to your project files on your Git provider’s site:

Integrating Pull Requests for Your Project

By default, Looker developers can commit and deploy their changes to production. However, instead of letting developers deploy their own changes to production, you can also set up your project with either the Pull Requests Recommended or the Pull Requests Required option.

The Pull Requests Recommended and Pull Requests Required options are only available if you are self-hosting your repository using a Git provider; these options won’t be shown if you are using a Looker-hosted repository for your LookML files. See this Help Center article for information about migrating to a new Git repository, such as from a Looker-hosted repository to a self-hosted repository.

Looker supports pull request integration for the following Git providers: GitHub, GitLab, Bitbucket Cloud, and Bitbucket Server (which was previously called “Stash”).

With either Pull Requests Recommended or Pull Requests Required, Looker developers submit a Git pull request for the changes on their branch. Once the developer creates the pull request, the other Looker developers can review and approve it from the Git provider’s web interface, where the webhook will push changes to your Looker project’s production branch.

Some additional notes on using pull requests with Looker:

Setting Up Your Project with Integrated Pull Requests

To set up your Looker project with Git pull requests:

  1. From your project, select Project Settings from the Git drop-down menu.
  2. In the Git Integration section, select Pull Requests Recommended or Pull Requests Required.
  3. Copy the webhook information and paste it to a text file to use later in this procedure.
  4. Optionally, click Set Webhook Secret to get a webhook deploy secret that authenticates your project’s Git integrations with your Git provider. Copy the deploy secret and paste it to a text file to use later in the procedure. See Webhook Deploy Secret for more information.
  5. Click Save Project Settings.

Next, use your Git provider’s interface to create a trigger for the webhook:

  1. Navigate to your project’s repository settings on your Git provider’s website.
  2. In your repository’s settings, click on Webhooks.
  3. Click Add webhook. This will open the Add webhooks window.
  4. In the Payload URL text box, paste the webhook information you copied from the Git Integration section in Looker.
  5. Optionally, in the Secret text box, paste the webhook deploy secret you copied from the Webhook Deploy Secret section in Looker.
  6. Select the option for Just the push event.
  7. Click Add webhook.

Now, whenever a Looker developer commits changes to your project, the Looker IDE will show the Open Pull Request button.

The 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:

Merge Options in the Git Provider’s Interface

If your Looker project is integrated with pull requests, your developers use your Git provider’s interface to submit pull requests and merge changes into the production branch.

Looker supports the merge commit method of merging changes from a development branch into your production branch. However, your Git provider’s interface may show additional options for merging:

Looker does not support squash merging or rebase merging, so your developers should avoid using these options. If possible, the best practice is to disable the options for your repository. The following example shows disabling those options in a GitHub repo:

  1. Navigate to your project’s repository settings on your Git provider’s website.

TIP: For projects configured with Git integration, you can use the View Project on Git option from the project’s Git menu in Looker.

  1. In your repository’s settings, click Options.
  2. Scroll down to the Merge button section.
  3. Uncheck the Allow squash merging and Allow rebase merging options.

Once you uncheck these options, they won’t be available when merging a branch in the repository:

Top