docs: add environment variables section to setup/teardown docs#779
docs: add environment variables section to setup/teardown docs#779
Conversation
📝 WalkthroughWalkthroughThis PR adds an "Environment Variables" section to the setup-teardown-scripts documentation, detailing SUPERSET_ROOT_PATH and SUPERSET_WORKSPACE_NAME with configuration examples, and reformats the TypeScript configuration file with improved formatting and additional type path includes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@apps/docs/tsconfig.json`:
- Around line 40-42: Remove the duplicated include pattern
".next/dev/dev/types/**/*.ts" from the tsconfig "include" array: locate the
include entries that contain ".next/types/**/*.ts", ".next/dev/types/**/*.ts",
and ".next/dev/dev/types/**/*.ts" and delete the offending
".next/dev/dev/types/**/*.ts" entry so the include list matches the standard
Next.js generated types patterns.
| ".next/types/**/*.ts", | ||
| ".next/dev/types/**/*.ts", | ||
| ".next/dev/dev/types/**/*.ts" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if .next/dev/dev/ path structure exists in the docs app or is referenced elsewhere
# Search for any references to dev/dev pattern in tsconfig files
echo "=== Searching for 'dev/dev' pattern in tsconfig files ==="
rg -n "dev/dev" -g "tsconfig*.json"
# Check other tsconfig files in the repo for comparison of .next include patterns
echo -e "\n=== Checking .next include patterns in other tsconfig files ==="
rg -n "\.next.*types" -g "tsconfig*.json"
# Look at the actual tsconfig.json file in the docs app
echo -e "\n=== Content of apps/docs/tsconfig.json ==="
cat -n apps/docs/tsconfig.jsonRepository: superset-sh/superset
Length of output: 2011
Remove the duplicated .next/dev/dev/types/**/*.ts path from the include array.
The path on line 42 contains duplicated dev directory segments. This pattern does not exist in any other TypeScript configuration in the repository (all other apps only include .next/types/**/*.ts), and it does not match the standard Next.js directory structure for generated types. This appears to be a copy-paste error and should be removed.
🤖 Prompt for AI Agents
In `@apps/docs/tsconfig.json` around lines 40 - 42, Remove the duplicated include
pattern ".next/dev/dev/types/**/*.ts" from the tsconfig "include" array: locate
the include entries that contain ".next/types/**/*.ts",
".next/dev/types/**/*.ts", and ".next/dev/dev/types/**/*.ts" and delete the
offending ".next/dev/dev/types/**/*.ts" entry so the include list matches the
standard Next.js generated types patterns.
🚀 Preview Deployment🔗 Preview Links
Preview updates automatically with new commits |
Kitenite
force-pushed
the
update-docs-w-env-variables
branch
from
9de745e to
0962815
Compare
Document the environment variables available to setup scripts, including SUPERSET_ROOT_PATH and SUPERSET_WORKSPACE_NAME provided by Superset.
Kitenite
force-pushed
the
update-docs-w-env-variables
branch
from
0962815 to
1e85044
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on February 14
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| ".next/types/**/*.ts", | ||
| ".next/dev/types/**/*.ts" | ||
| ".next/dev/types/**/*.ts", | ||
| ".next/dev/dev/types/**/*.ts" |
There was a problem hiding this comment.
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.
1 participant
Summary
SUPERSET_ROOT_PATHandSUPERSET_WORKSPACE_NAMEvariables provided by Superset.envto workspaceTest plan
Note
Adds clear guidance on environment variables available to setup/teardown scripts and a minimal usage example.
setup-teardown-scripts.mdxdocumentingSUPERSET_ROOT_PATHandSUPERSET_WORKSPACE_NAMEwith a bash exampleapps/docs/tsconfig.jsonto include an additional.next/dev/dev/types/**/*.tspath for type checkingWritten by Cursor Bugbot for commit 5cb8a51. This will update automatically on new commits. Configure here.