ss-tools/specs/011-git-integration-dashboard/quickstart.md

Quickstart: Git Integration for Dashboards

Prerequisites

• A running Superset instance.
• A Git repository (GitLab, GitHub, etc.) created for your dashboard.
• A Personal Access Token (PAT) with repo scope.

Setup Guide

1. Configure Git Connection

1. Navigate to the Git Integration tab in the tools menu.
2. Select your Dashboard from the dropdown.
3. Enter your Git Provider details:
   • Repo URL: https://github.com/myorg/sales-dashboard.git
   • Username: myuser
   • PAT: ghp_xxxxxxxxxxxx
4. Click Save & Connect. The system will clone the repository.

2. Development Workflow

Making Changes

1. Edit your dashboard in Superset as usual.
2. Go to the Git Integration panel.
3. Click Sync Status. This pulls the latest state from Superset and compares it with the Git repo.
4. You will see a list of changed files (e.g., charts/my-chart.yaml).

Committing

1. Select the files you want to include.
2. Enter a commit message.
3. Click Commit.

Pushing

1. Click Push to send your changes to the remote repository.

3. Branching

1. To work on a new feature, go to the Branches tab.
2. Enter a name (e.g., feature/Q4-updates) and click Create Branch.
3. The system automatically switches to this branch.

4. Deploying

1. Switch to the Deploy tab.
2. Select the target environment (e.g., "Production").
3. Click Deploy. The current version of the dashboard will be imported into the target environment.