Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions apps/docs/content/docs/setup-teardown-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,31 @@ chmod +x .superset/setup.sh
3. Commands execute in a terminal tab so you can see output
4. When deleting a workspace, teardown commands run before the worktree is removed

## Environment Variables

Superset provides environment variables to your setup scripts. These are available when your commands run:

### Provided by Superset

| Variable | Description |
|----------|-------------|
| `SUPERSET_ROOT_PATH` | Absolute path to the root repository (main worktree) |
| `SUPERSET_WORKSPACE_NAME` | Name of the workspace being created (defaults to directory name) |

### Example Usage

Your setup script can use these variables to access shared configuration:

```bash
#!/usr/bin/env bash

# Copy shared environment from root to workspace
cp "$SUPERSET_ROOT_PATH/.env" .env

# Use workspace name for resource naming
echo "Setting up workspace: $SUPERSET_WORKSPACE_NAME"
```

## Tips

- Keep setup scripts fast - they run every time you create a workspace
Expand Down
3 changes: 2 additions & 1 deletion apps/docs/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts",
".next/dev/types/**/*.ts"
".next/dev/types/**/*.ts",
".next/dev/dev/types/**/*.ts"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated tsconfig change with suspicious duplicate path

Low Severity

The include array now contains .next/dev/dev/types/**/*.ts with a suspicious double dev/dev path pattern. This change is unrelated to the PR's stated purpose of documenting environment variables. Other apps in this monorepo only include .next/types/**/*.ts. The duplicate dev directory likely indicates a typo or an accidentally committed change from a debugging session.

Fix in Cursor Fix in Web

],
"exclude": ["node_modules"]
}
14 changes: 7 additions & 7 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.