Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-06-02 11:59:17 +08:00
Code Issues Actions 21 Packages Projects Releases Wiki Activity

Prettier

Browse Source
This commit is contained in:
Hamish Willee
2026-02-11 16:02:27 +11:00
committed by Ramon Roche
parent 89b5a61f79
commit 3c80be8e48
1 changed files with 53 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/test_and_ci/continous_integration.md
+11 -11
View File
@@ -17,7 +17,7 @@ Jobs are organized in tiers, where each tier depends on the previous one complet
#### Tier Structure
| Tier | Job | PR | Push | Description |
|------|-----|----|------|-------------|
| ---- | -------------- | ----------------- | -------------- | ------------------------------------------------------------- |
| T1 | Detect Changes | Yes | — | Checks if source code files changed (triggers metadata regen) |
| T2 | PR Metadata | Yes (conditional) | — | Builds PX4 SITL and regenerates all auto-generated docs |
| T2 | Metadata Sync | — | Yes | Builds PX4 SITL, regenerates metadata, auto-commits |
@@ -29,7 +29,7 @@ Jobs are organized in tiers, where each tier depends on the previous one complet
When a PR modifies files in `docs/**` or the orchestrator workflow file itself, the workflow validates the changes:
```
```txt
PR Event
│
▼
@@ -63,7 +63,7 @@ PR Event
```
| Job | Duration | Description |
|-----|----------|-------------|
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
| **T1: Detect Changes** | ~10s | Determines if metadata regeneration is needed |
| **T2: PR Metadata** | ~10-15m | Rebuilds PX4 SITL and regenerates all metadata (only if source files changed) |
| **T2: Link Check** | ~30s | Checks for broken links in changed markdown files and posts a sticky comment to the PR |
@@ -73,7 +73,7 @@ PR Event
When changes are pushed to `main` or `release/**` branches that affect docs or source paths, the workflow regenerates metadata, builds, and deploys:
```
```txt
Push Event
│
▼
@@ -105,7 +105,7 @@ Push Event
```
| Job | Duration | Description |
|-----|----------|-------------|
| --------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| **T2: Metadata Sync** | ~10-15m | Rebuilds PX4 SITL, regenerates all metadata, formats with Prettier, auto-commits with `[skip ci]` |
| **T3: Build Site** | ~7-10m | Builds the VitePress documentation site |
| **T4: Deploy** | ~3m | Syncs built site to AWS S3 (HTML: 60s cache, assets: 24h cache) |
@@ -117,7 +117,7 @@ Crowdin upload is handled by a separate workflow (see below).
The metadata regeneration job creates the following auto-generated documentation:
| Type | Output | Description |
|------|--------|-------------|
| ------------------ | ------------------------------------------------ | -------------------------------------------- |
| Parameters | `docs/en/advanced_config/parameter_reference.md` | Complete parameter reference |
| Airframes | `docs/en/airframes/airframe_reference.md` | Airframe configurations |
| Modules | `docs/en/modules/*.md` | Module documentation |
@@ -136,7 +136,7 @@ The workflow triggers on different paths depending on the event:
**Push** (main/release branches):
| Path | Reason |
|------|--------|
| ------------------------ | ------------------------------------- |
| `docs/**` | Documentation source files |
| `src/**` | Source code changes affect metadata |
| `msg/**` | Message definitions affect metadata |
@@ -146,7 +146,7 @@ The workflow triggers on different paths depending on the event:
**Pull Request:**
| Path | Reason |
|------|--------|
| ----------------------------------------- | ------------------------------ |
| `docs/**` | Documentation source files |
| `.github/workflows/docs-orchestrator.yml` | Changes to the workflow itself |
@@ -159,7 +159,7 @@ Source-only changes on PRs are detected at runtime by the T1: Detect Changes job
This scheduled workflow downloads completed translations from Crowdin and creates pull requests.
| Setting | Value |
|---------|-------|
| -------------------- | ------------------------------------------------------- |
| **Schedule** | Every Sunday at 00:00 UTC |
| **Target Languages** | Korean (ko), Ukrainian (uk), Chinese Simplified (zh-CN) |
@@ -174,7 +174,7 @@ This scheduled workflow downloads completed translations from Crowdin and create
The workflows use caching to speed up builds:
| Cache | Size | Purpose |
|-------|------|---------|
| ------------ | ----- | ------------------------------------- |
| ccache | 1GB | C++ compilation cache for SITL builds |
| node_modules | ~26MB | Node.js dependencies for VitePress |
@@ -183,7 +183,7 @@ The workflows use caching to speed up builds:
Jobs run on [runs-on](https://runs-on.com/) self-hosted runners with S3 cache:
| Job | Runner |
|-----|--------|
| ------------------ | ------------------------------ |
| T1: Detect Changes | ubuntu-latest |
| T2: PR Metadata | 4 CPU (with px4-dev container) |
| T2: Metadata Sync | 4 CPU (with px4-dev container) |