Skip to main content
This feature is currently in beta. Reach out to Omni support to have it enabled for your organization.
With serialized content in git, teams can work on content and model changes together in a single version-controlled workflow. They will be able to develop changes on branches, review them through pull requests, and use CI/CD to automate validation and deployment.

​
How it works

When a document has Require pull requests to publish enabled and its model is connected to git, Omni writes the document itself into the repository. A branch that includes a draft of the document commits the draft’s files under omni/content/ at the repository root. The pull request then shows the model change and the content change side by side, and reviewers can read both before anything is published.

​
Requirements

To commit a document to git, all the following must be true:
  • Your organization is enrolled in the beta.
  • The model the document is built on is connected to a GitHub repository through the git integration.
  • An Organization Admin has enabled Require pull requests to publish for the organization, under Settings > Content Permissions.
  • Require pull requests to publish is enabled for the document, under File > Document settings. You need the Content Manager role on the document to change it.
  • Users who edit the document have the Querier role or higher, because the change happens on a branch.

​
Limitations

Once a document requires a pull request to publish, it becomes readable to anyone with read access to the repository. Personal documents can’t be hidden.
  • Only supported for GitHub. Other git providers aren’t currently supported.
  • Changes made to document files in git don’t sync back into Omni. Omni is the source of truth, and git retains a copy for review and history.
  • Only dashboards and apps are committed. Skills and workbook-only documents, meaning saved workbooks without a dashboard or app, are not.
  • Commits don’t include deliveries and document metadata. This includes document permissions, favorites, and labels.
  • Classic dashboards can’t be written to git. Omni commits a short stand-in file for these documents, so the pull request still works. Upgrade the classic dashboard to commit its files.
  • Dashboard settings are not synced to git. Updating settings on a document does not require a pull request.
  • Moving a document in Omni doesn’t require a PR. The new document location will be reflected in git either on the next automated sync or when a PR is opened on that document.

​
Learn more

Sync to git

How a draft becomes a pull request, and how Omni keeps the default branch current.

Repository structure

Where document files live in the repository and what each file holds.

Troubleshooting

Why a commit stopped, and what to change.