Overview
This tool lets you manage Sigma data models as code using GitHub for version control. Changes are made here, committed to GitHub via PR, and automatically synced to Sigma when merged.
Step 1: Get Sigma API Credentials
- Log in to Sigma Computing
- Go to Administration â Developer Access
- Click Create New under Client Credentials
- Copy the Client ID and Client Secret
â ī¸ Save the Client Secret immediately - you cannot view it again!
Step 2: Set Up GitHub Repository
- Create a new private GitHub repository
- Download the repo template files and copy them to your repository
- Your repo structure should look like:
.github/workflows/ - automation workflowsscripts/ - Python sync scriptsdata-models/ - your JSON filesconfig.yml - configuration
- Commit and push these files to your repo
Step 3: Configure GitHub Secrets & Variables
Go to your repo: Settings â Secrets and variables â Actions
Add Repository Secrets:
SIGMA_CLIENT_ID | Your Sigma API Client ID |
SIGMA_SECRET | Your Sigma API Client Secret |
Add Variables (click Variables tab):
SIGMA_CLOUD | aws, azure, or gcp |
SIGMA_FOLDER_ID | Folder ID for new data models |
Step 4: Enable Workflow Permissions
- Go to Settings â Actions â General
- Under Workflow permissions, select "Read and write permissions"
- Check "Allow GitHub Actions to create and approve pull requests"
- Click Save
Step 5: Create GitHub Personal Access Token
- Go to github.com/settings/tokens
- Click Generate new token (classic)
- Select only the
repo scope
- Click Generate token
- Copy the token (starts with
ghp_)
Step 6: Find Your Sigma Folder ID
- In Sigma, navigate to the folder where you want data models created
- Look at the URL:
...sigmacomputing.com/.../folder/abc123xyz
- The folder ID is the last part of the URL
Using This Tool
- Enter your Sigma credentials above and click Connect to Sigma
- Enter your GitHub token and repo (format:
owner/repo-name)
- Click Connect to GitHub
- Select a data model to edit, or click + New to create one
- Make changes and click Commit Changes
- Review and merge the PR on GitHub
- Changes automatically sync to Sigma! â
Syncing Changes from Sigma UI
If you edit a data model directly in Sigma's UI:
- Select the data model in this tool
- Click âģ Pull from Sigma
- Click Commit Changes to save to GitHub