Version control for Liveboards and Answers

With version control, every time a user saves changes to a Liveboard or Answer, a new version is created and stored in Github. Any user with edit access to the Liveboard or Answer can browse the version history in ThoughtSpot and restore any saved versions whenever needed. Version control must be enabled at the Org level. After that, it can be enabled on specific Liveboards and Answers where version control is wanted.

There are two steps to enabling version control in ThoughtSpot, which must be done in the following order:

  1. Enable version control for the Org.

  2. Enable version control for specific Liveboards or Answers in the Org.

Version control cannot enabled by default for all Liveboards and Answers.

Version control for an Org

Prerequisites

To enable version control for an Org, the following are required:

  • Administrator access to the cluster/Org

  • GitHub repository created in Github or GitHub Enterprise

  • Github user ID of admin who has access to the repository

  • Github repository configured with:

    • One commit branch for each Org where you are enabling version control

      • TML files for each Liveboard and Answer enabled for version control are stored here.

    • One configuration branch

      • A set of configuration files required for the GIT integration and CI/CD to work.

        ThoughtSpot recommends not using the Main branch for either commits or configuration.
    • Personal access token from Github (Classic or fine-grained)

      • Under Select scopes, be sure to select the repo checkbox before clicking Generate token.

  • The https URL to the Github repository.

Enabling version control for an Org

To enable version control for an Org, do the following:

  1. Go to the Admin tab.

  2. Select the Org where you want to enable version control.

  3. Under Application settings, select Version Control.

  4. Under the message "Version control not configured", Click Configure.

    github creds
  5. In the Enter Github Credentials window, do the following:

    1. For Repository, enter the Github repository to store version control information.

    2. For Username, enter your Github username.

    3. For Token, enter or paste your personal access token associated with your Github username.

      If you don’t a have personal access token yet, sign into Github and create one of the following access tokens, and enter it in the Token field:

      1. Classic

      2. fine-grained

        Under Select scopes be sure to select the repo checkbox before clicking Generate token.

  6. Click Continue.

  7. In the Select Branch window, do the following:

    • For Commit branch select the commit branch you created in your repository.

    • For Configuration branch select the configuration branch you created in your repository.

    • Make sure the Save version history checkbox is selected.

  8. Click Enable.

Version control is now enabled for your Org. In order for version control to be available for any Liveboard or Answer, it must be enabled individually in the Liveboard or Answer.

Version control for a Liveboard or Answer

Prerequisites

To enable version control on a Liveboard or Answer, the following is required:

  • Admin or Developer privilege

  • Edit permission on the Liveboard or Answer and the underlying datasource(s)

Enabling version control for a Liveboard or Answer

To enable version control for a Liveboard or Answer, do the following:

  1. Navigate to the Liveboard or Answer where you want to enable version control.

  2. Click the More menu more menu, and select Enable Version Control.

Editing the version control configuration

After you enable version control for an Org, you can edit the configuration. However, changing these settings will cause a service interruption for all users of a few minutes. Consider making your changes during a scheduled maintenance window.

  1. Go to the Admin tab.

  2. Select the Org where you want to edit version control.

  3. Under Application settings, select Version Control.

  4. Click Edit.

  5. In the Enter Github credentials window, Make any changes required to the Repository, Username, or Token and click Continue.

  6. In the Select Branch window, make any changes required to the Commit and Configuration branches, make sure the Save version history checkbox is selected, and click Update.

Resetting the version control configuration

Resetting your version control configuration, deletes the configuration completely, causing all version history from your GIT branches to be lost.

To reset the version control configuration, do the following:

  1. Click Reset Configuration.

    The Reset Configuration message appears asking you if you really want to reset the configuration.

  2. To proceed, click Yes.


Was this page helpful?