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

Quickstart: Git Integration Plugin

Setup

1. Install Dependencies:

   cd backend && .venv/bin/pip install GitPython
   

2. Configure Git Server:

   • Go to Settings -> Git Integration
   • Click "Add Server"
   • Select Provider (e.g., GitLab)
   • Enter Server URL and Personal Access Token (PAT)
   • Click "Test Connection" and "Save"

3. Link Dashboard to Git:

   • Navigate to the Dashboard view
   • Select a dashboard
   • Click "Enable Git Integration"
   • Select the Git server and provide repository path (e.g., my-org/my-dashboard-repo)

Common Workflows

Versioning Changes

1. Make changes to the dashboard in Superset.
2. In the Git Integration panel, click "Commit".
3. Enter a commit message and select files (metadata, charts, etc.).
4. Click "Push" to sync with remote.

Branching

1. Click "New Branch".
2. Enter branch name (e.g., feature/new-charts).
3. The dashboard state is now tracked on this branch.

Deployment

1. Ensure changes are committed and pushed.
2. Click "Deploy".
3. Select target environment (e.g., "Production").
4. Monitor deployment logs for success.