Git Integration

👤 This documentation is intended for Site Administrators.

With Git Integration, Periscope provides data professionals with complete control over their analytics environment, offering file-level access to user generated content, and support for release management workflows. Unlike other analytics solutions, Periscope provides a complete bi-directional sync for all user generated content including Dashboards, Charts, Views, Snippets, Filters and Alerts and works with any remote Git repository, including an owned Git server.

For instructions on how to connect a Git repository to Periscope refer to the Connecting a Git repository page.
For more information on the structure of the repository and configuration files, refer to the Git Configuration page.

Table of Contents:

<UL>
<LI><a href="#GitUseCases">Git Use Cases</a></LI>
<LI><a href="#HowItWorks">How It Works</a></LI>
<LI><a href="#GitDisconnect">Disconnecting Git</a></LI>
<LI><a href="#GitCommits">Git Commits in the History Tab</a></LI>
</UL>

Note: Git Integration is available on select plans. Site administrators can contact their Account Manager for additional information.
With the 2018 release, Git Integration supports Snippets, Views, Charts, and Dashboards.

<HR>

<a name="GitUseCases"></a>

Git Use Cases

<OL>
<LI><b>Sophisticated, externalized version control with code review</b></LI>
<UL><LI>Git integration gives users all of the great features and functionality of Git as a version control system, in addition to providing full, external access to all user generated content.</a></LI></UL>
<LI><b>Automate content creation, search & replace, and clone across Spaces</b></LI>
<UL><LI>With user generated content represented externally as a set of files in a Git repository, users have the power and flexibility to perform any kind of batch processing and automation on their data. Some examples include programmatically creating, editing, and deprecating dashboards, finding and replacing across many files, cloning objects across Spaces, and much more.</b></LI></UL>
<LI><b>Release Management</b></LI>
<UL><LI>Ensure a reliable and stable production environment by previewing and collaborating on changes on a branch prior to pushing live to production.</LI></UL>
</OL>

<a href="#top">Back to top</a>

<a name="HowItWorks"></a>

How It Works

<OL>
<LI>User creates an empty remote repository (GitHub, GitLab, Bitbucket, corporate Git Server, etc) and links it to a Space in Periscope (one repository per Space)</LI>
<LI>Once configured, a two way sync is established between the Space in Periscope and the user's remote repository (all supported objects will be synced automatically on initial sync and going forward)</LI>
<LI>Any changes made to the supported objects in Periscope are instantly synced to the user's remote repository</LI>
<LI>Any changes merged into the periscope/master branch in the user's remote repository are instantly synced to Periscope</LI>
</OL>

<a href="#top">Back to top</a>

<a name="GitDisconnect"></a>

Disconnecting Git

This feature is still in development.

Site administrators can contact support@periscopedata.com if they would like to disconnect a repo. Please note that this may take a few days to complete.

<a href="#top">Back to top</a>

<a name="GitCommits"></a>

Git Commits in the History Tab

This feature is still in development, however, is currently available with a limited feature set. Both changes made in-app as well as from your Git repository will appear in the same format in the History tab.

<a href="#top">Back to top</a>

Our support team is ready to help