Skip to main content
You can either onboard using a Honeydew-managed GitHub private repository, or use your own GitHub repository. If you would like to use your own repository, please complete the following steps:
1

Create a GitHub Repository

Create a new GitHub private repository using one of these options:
2

Install the Honeydew GitHub Application

Install the Honeydew GitHub application, and provide it with access to the newly created repository.
3

Configure allowed IP addresses

If you are restricting access to your GitHub organization using IP addresses allow list, add the IP addresses displayed in the GitHub connection screen in Honeydew App settings page to the “IP Allow List” of your GitHub organization.
For the Honeydew Cloud deployment, the following IP addresses are used:
  • 34.86.209.90
  • 34.145.147.92
If you are using a private Honeydew deployment, the IP addresses will be different. You can find them in the GitHub connection screen in Honeydew App settings page.
4

Set up Honeydew

  1. Go to the GitHub connection screen in Honeydew Studio settings page
  2. Click on the Connect to GitHub button and login to your GitHub account
  3. Select the newly created repository from the list and click Save
You are all set! Honeydew will now use this GitHub repository for storing a version controlled semantic layer.
If you have protection rules for new repositories, you may need to grant the Honeydew GitHub application the ability to bypass these rules. Specifically, please disable rules requiring at least one reviewer for pull requests for the Honeydew GitHub application.This applies when every pull request should merge automatically. If you instead want approval to be required before changes reach prod, do not grant the application a bypass — see Change Approval.

​
Clean up merged branches

Honeydew creates a Pull Request when you publish changes, but does not delete the branch when that Pull Request is merged in GitHub. Enable automatic branch deletion so merged branches do not accumulate in the Honeydew branch list:
  1. Go to Settings -> General in your repository
  2. Under Pull Requests, select Automatically delete head branches
See the GitHub documentation on managing the automatic deletion of branches for the current steps.
Branch protection rules and repository rules can prevent GitHub from deleting a branch automatically. If merged branches still appear in Honeydew, check the rules that apply to your branches.
See Branch cleanup after merge for how branch deletion affects the Honeydew branch list.

​
Validate changes with GitHub Actions

Once your repository is connected, you can validate semantic-layer changes on every pull request using the Honeydew GitHub Action. Make it a required status check to block pull requests that would introduce validation errors before they reach prod. See GitHub Actions for setup, and CI/CD Overview for the full automation workflow.