Skip to content

Latest commit

 

History

History
94 lines (80 loc) · 3.45 KB

config.md

File metadata and controls

94 lines (80 loc) · 3.45 KB

How should I set up my GitHub Repository?

The ThoughtSpot version control APIs work by linking a git branch to a ThoughtSpot Org, using the configure Git integration REST API.

Further reading Git Integration Overview

Important

A paired Git branch and ThoughtSpot Org are called an environment.

We strongly recommend creating a new branch for each environment, and labeling each branch with a common prefix.

Additional branches may be created for non-environmental purposes (documentation, complementary ThoughtSpot code, etc..) however you should never merge them into the environment branches.

It is recommended that you use the ts- prefix for all environment branches, and create a ts-config branch in order to automatically map guids between environments. ThoughtSpot will automatically make a commit to this branch on successful deployments.

For example, if we have DEV, UAT, and PRD environments, your branch strategy may look like..

---
title: ThoughtSpot CI Repository Configuration
---
%%{
    init: {
        'logLevel': 'debug',
        'theme': 'default',
        'themeVariables': {
            'git0': '#393939',
            'git1': '#8d63f5',
            'git2': '#4ab565',
            'git3': '#fea85f',
            'gitBranchLabel3': '#000000',
            'git4': '#fe476e',
            'commitLabelColor': '#f1f4f8',
            'commitLabelBackground': '#000000'
        }
    }
}%%
gitGraph
   commit
   branch ts-config
   branch ts-prd
   branch ts-uat
   branch ts-dev
   checkout ts-dev
   commit
   commit
   commit
   checkout ts-uat
   merge ts-dev
   checkout ts-config
   commit
   checkout ts-dev
   commit
   commit
   checkout ts-prd
   merge ts-uat
   checkout ts-config
   commit
   checkout ts-dev
   commit
   commit
   checkout ts-uat
   merge ts-dev
   checkout ts-config
   commit
   checkout ts-prd
   merge ts-uat
   checkout ts-config
   commit
   checkout ts-dev
   commit
Loading

Where the only "manual" work happens in the ThoughtSpot Development environment (read: Org).

  • Changes are moved from ThoughtSpot -> DEV only through the Commit Workflow process.
  • Changes are moved from DEV -> UAT only through the Pull Request process.
  • Changes are moved from UAT -> PRD only through the Pull Request process.

On acceptance and merge of the PR, changes are deployed to the ThoughtSpot Org.

How should I set up my ThoughtSpot?

  • Go to Develop tab of Org for which you want to create Config
  • In Rest API Section, select REST Playground v1
  • In API ENDPOINT section, select version control where we need to create a config file.
  • Create a config for Thoughtspot to login to Github REPO where you want to do version control of TS Objects.
  • Provide the Parameters
  • To get repository configuration information, select Search API