Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Organization Admin permissions are required to access and modify a model’s git settings.
After a git repository is connected to a model, you can configure the integration’s behavior by navigating to Model > Git Settings in the model IDE.

​
Test git connection

Clicking the Test git connection button will test the connection’s Deploy key setup. Note: This doesn’t currently test the repository’s webhook setup. To disconnect the repository from the model, click the Unlink git button.

​
Pull request settings

​
Base branch

Defines the target branch for Omni pull requests. Omni defaults this setting to main, but it may be different for your repository. If you’re unsure which branch is the default for your repository, check your repository’s settings page:

​
Pull request required

Enabling this setting will require all changes to the model to be made through a pull request. Otherwise, changes can be directly promoted to the shared model. If you’re familiar with git, this is equivalent to committing changes directly to the repository’s base (default) branch.
For additional control, you can define rules in the git repository that require pull requests to be reviewed and approved before they’re merged. Refer to the documentation for your git provider to learn more:

​
Require for system syncs

Some Omni actions, such as schema refreshes, API events, and model syncs, will automatically commit changes to the repository’s base branch, making them visible in the shared model. Enabling the Pull request required > Require for system syncs setting will require that these actions are merged via a pull request. To use this setting, the following settings must also be enabled:

​
Git follower mode

Enables follower mode for the model.

​
Source model name

Determines the path to the model files in the connected repository. If follower mode is enabled, values for the leader and follower(s) must match.

​
Always create branches

When the Create Omni branches for all pull requests setting is enabled, pull requests in the connected repository will create a corresponding branch in Omni.

​
Custom web URL

When your git repository’s SSH URL goes through a tunnel or VPC, Omni may not be able to automatically generate valid web links to view pull requests or browse repository files. The Custom web URL setting allows you to specify an alternate HTTPS URL that Omni will use instead. When this field is set, Omni will use the custom URL to generate:
  • Pull request URLs
  • Repository file browsing links
If left blank, Omni will automatically derive the web URL from the repository’s SSH URL. For example, if your repository’s SSH URL is git@github.com:your-org/your-repo.git but it goes through a private tunnel, you can set the custom web URL to https://github.com/your-org/your-repo to ensure repository links work correctly.

​
Authentication

​
Access token

If your repository is configured with HTTPS token authentication, you can update the access token using the Change Token button. This is useful when:
  • Your access token has expired
  • You need to rotate tokens for security purposes
  • You want to use a different token with updated permissions
To change the token:
  1. Click the Change Token button.
  2. Enter the new access token.
  3. Click Save to update the connection.
The connection will be re-validated with the new token.

​
Deploy key

The Deploy key allows Omni to read from and commit to the connected git repository when using SSH authentication. Refer to the git integration setup guides to learn how to add the key to your repository.

​
Pull request webhook

The Pull request webhook settings allow Omni to be notified when pull request-related actions are taken in the repository. This is required to keep your git and Omni branches in sync. Refer to the git integration setup guides to learn how to add the webhooks to your repository.

​
Webhook secret

When using SSH authentication, Omni generates a webhook secret that is used to verify webhook requests from your git provider. This secret ensures that only authorized webhook events from your repository are processed by Omni.

​
Rotating webhook secrets

Webhook secret rotation is only available when using SSH authentication. HTTPS token authentication does not use webhook secrets.
If your webhook secret has been compromised or you need to rotate it for security purposes, you can generate a new secret without unlinking and re-linking your git repository. To rotate the webhook secret:
1

Open Git settings

Navigate to Model > Git settings in the model IDE.
2

Rotate the secret

In the Pull request webhook section, click the Rotate secret button.
3

Confirm the rotation

A confirmation dialog will appear warning that the current secret will stop working immediately. Click Confirm to proceed.
4

Copy the new secret

Copy the new webhook secret.
5

Update your git provider

Update the webhook configuration in your git provider with the new secret:
When you rotate the webhook secret, the old secret is immediately invalidated. You must update the webhook configuration in your git provider with the new secret to continue receiving webhook events. Until the webhook is updated, Omni will not receive notifications about pull request activity in the repository.