mirror of
https://github.com/apache/superset.git
synced 2026-05-22 08:15:36 +00:00
cbcfd9599f
Snapshots all four versioned Docusaurus sections at v6.1.0. Built on top of the version-cutting tooling work in chore/docs-cut-6.1.0-versions so the snapshot benefits from: - Auto-gen refresh before snapshotting (database pages from engine spec metadata, API reference from openapi.json, component pages from Storybook stories) — captured at the SHA we cut from rather than whatever happened to be on disk. - Data-import freeze: country list, feature flag table, database diagnostics, and component metadata are copied into snapshot-local `_versioned_data/` dirs so the historical version doesn't silently mutate when the source files change. - Depth-aware import-path rewriter that handles deeply-nested component MDX files referencing `../../../src/` from the snapshot. Versioning behavior: `lastVersion` stays at `current` for every section, so the canonical URLs (`/docs/...`, `/admin-docs/...`, `/developer-docs/...`, `/components/...`) continue to render content from master. The `current` version is consistently labeled "Next" with an `unreleased` banner, and `6.1.0` is a historical pin accessible only via its explicit version segment. Component playground: previously `disabled: true` in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the `disabled` flag, so no other code changes were needed to bring it back online. The frozen `databases.json` in the snapshot is the canonical 80-database artifact from the latest committed state in master (preserved by the generator's input-hash cache), not a fallback regenerated from a local Flask environment.
1.8 KiB
1.8 KiB
title, sidebar_position
| title | sidebar_position |
|---|---|
| CI/CD and Automation | 5 |
CI/CD and Automation
🚧 Coming Soon 🚧
Understanding Superset's continuous integration and deployment pipelines.
Topics to be covered:
- GitHub Actions workflows
- Pre-commit hooks configuration
- Automated testing pipelines
- Code quality checks (ESLint, Prettier, Black, MyPy)
- Security scanning (Dependabot, CodeQL)
- Docker image building and publishing
- Release automation
- Performance benchmarking
- Coverage reporting and tracking
Pre-commit Hooks
# Install pre-commit hooks
pre-commit install
# Run all hooks on staged files
pre-commit run
# Run specific hook
pre-commit run mypy
# Run on all files (not just staged)
pre-commit run --all-files
GitHub Actions
Key workflows:
test-frontend.yml- Frontend teststest-backend.yml- Backend testsdocker.yml- Docker image buildscodeql.yml- Security analysisrelease.yml- Release automation
This documentation is under active development. Check back soon for updates!