mirror of
https://github.com/apache/superset.git
synced 2026-05-29 11:45:16 +00:00
docs(ci): complete bun/turborepo/changesets migration docs and workflows
- Update all CI workflows (pre-commit, tech-debt) to use Bun - Update build scripts (js_build.sh, cypress_build.sh, eslint.sh) for Bun - Add sync-package-versions.js script for release version alignment - Simplify package.json scripts (build:packages, publish:packages) - Add gitTag: false to changesets config to avoid repo tag clutter - Remove obsolete Lerna scripts (build.js, lernaVersion.sh) - Update RELEASING/README.md with comprehensive npm publishing guide - Update all developer documentation for Bun usage - Update LLM instruction files (AGENTS.md, dev-standard.mdc) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -34,23 +34,23 @@ Apache Superset uses Playwright for end-to-end testing, migrating from the legac
|
||||
cd superset-frontend
|
||||
|
||||
# Run all tests
|
||||
npm run playwright:test
|
||||
# or: npx playwright test
|
||||
bun run playwright:test
|
||||
# or: bun x playwright test
|
||||
|
||||
# Run specific test file
|
||||
npx playwright test tests/auth/login.spec.ts
|
||||
bun x playwright test tests/auth/login.spec.ts
|
||||
|
||||
# Run with UI mode for debugging
|
||||
npm run playwright:ui
|
||||
# or: npx playwright test --ui
|
||||
bun run playwright:ui
|
||||
# or: bun x playwright test --ui
|
||||
|
||||
# Run in headed mode (see browser)
|
||||
npm run playwright:headed
|
||||
# or: npx playwright test --headed
|
||||
bun run playwright:headed
|
||||
# or: bun x playwright test --headed
|
||||
|
||||
# Debug specific test file
|
||||
npm run playwright:debug tests/auth/login.spec.ts
|
||||
# or: npx playwright test --debug tests/auth/login.spec.ts
|
||||
bun run playwright:debug tests/auth/login.spec.ts
|
||||
# or: bun x playwright test --debug tests/auth/login.spec.ts
|
||||
```
|
||||
|
||||
### Cypress (Deprecated)
|
||||
@@ -152,11 +152,11 @@ Playwright generates multiple reports for better visibility:
|
||||
|
||||
```bash
|
||||
# View interactive HTML report (opens automatically on failure)
|
||||
npm run playwright:report
|
||||
# or: npx playwright show-report
|
||||
bun run playwright:report
|
||||
# or: bun x playwright show-report
|
||||
|
||||
# View test trace for debugging failures
|
||||
npx playwright show-trace test-results/[test-name]/trace.zip
|
||||
bun x playwright show-trace test-results/[test-name]/trace.zip
|
||||
```
|
||||
|
||||
### Report Types
|
||||
|
||||
@@ -44,16 +44,16 @@ Comprehensive guide for testing Superset's frontend components and features.
|
||||
|
||||
```bash
|
||||
# Run all frontend tests
|
||||
npm run test
|
||||
bun run test
|
||||
|
||||
# Run tests in watch mode
|
||||
npm run test -- --watch
|
||||
bun run test -- --watch
|
||||
|
||||
# Run tests with coverage
|
||||
npm run test -- --coverage
|
||||
bun run test -- --coverage
|
||||
|
||||
# Run specific test file
|
||||
npm run test -- MyComponent.test.tsx
|
||||
bun run test -- MyComponent.test.tsx
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -80,16 +80,16 @@ Superset embraces a testing pyramid approach:
|
||||
### Quick Commands
|
||||
```bash
|
||||
# Frontend unit tests
|
||||
npm run test
|
||||
bun run test
|
||||
|
||||
# Backend unit tests
|
||||
# Backend unit tests
|
||||
pytest tests/unit_tests/
|
||||
|
||||
# End-to-end tests
|
||||
npm run playwright:test
|
||||
bun run playwright:test
|
||||
|
||||
# All tests with coverage
|
||||
npm run test:coverage
|
||||
bun run test:coverage
|
||||
```
|
||||
|
||||
### Test Development Workflow
|
||||
|
||||
@@ -42,10 +42,10 @@ To run the main Superset Storybook locally:
|
||||
cd superset-frontend
|
||||
|
||||
# Start Storybook (opens at http://localhost:6006)
|
||||
npm run storybook
|
||||
bun run storybook
|
||||
|
||||
# Build static Storybook
|
||||
npm run build-storybook
|
||||
bun run build-storybook
|
||||
```
|
||||
|
||||
### @superset-ui Package Storybook
|
||||
@@ -55,12 +55,11 @@ The `@superset-ui` packages have a separate Storybook for component library deve
|
||||
```bash
|
||||
cd superset-frontend
|
||||
|
||||
# Install dependencies and bootstrap packages
|
||||
npm ci && npm run bootstrap
|
||||
# Install dependencies and build packages
|
||||
bun install && bun run turbo:build
|
||||
|
||||
# Start the @superset-ui Storybook (opens at http://localhost:9001)
|
||||
cd packages/superset-ui-demo
|
||||
npm run storybook
|
||||
bun run plugins:storybook
|
||||
```
|
||||
|
||||
## Adding Stories
|
||||
@@ -78,7 +77,7 @@ storybook/stories/<package>/index.js
|
||||
1. Add package dependencies:
|
||||
|
||||
```bash
|
||||
npm install <package>
|
||||
bun add <package>
|
||||
```
|
||||
|
||||
2. Create a story folder matching the package name:
|
||||
|
||||
Reference in New Issue
Block a user