hotfix(docs): exclude AirSim scene binaries from docs builds (0.20.8) - #421
Merged
Conversation
The same-dir plugin publishes the whole repo tree as site content, and the downloaded Microsoft AirSim UE4 scenes (simulation/ms-airsim/assets/scenes/) and environments (simulation/ms-airsim/environments/) were not in exclude_docs, so every mkdocs build/serve on a machine with scenes fetched copied ~15 GB of Unreal .debug binaries and zips into the site directory. No pages or links reference either directory. Bumps VERSION 0.20.7 -> 0.20.8 and records the change in the release notes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
PR #419 added 'edit_uri: !ENV [DOCS_EDIT_URI, "edit/main/"]' to mkdocs.yml. The contract test parses mkdocs.yml with a SafeLoader that only knew the !!python/name tag, so all four docs-catalog contract tests have failed on main and develop since 2026-08-29. Collapse !ENV to its default value. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Test Metrics —
|
| Test | Pass | Fail | Skip | Rate |
|---|---|---|---|---|
| test_colcon_build_gcs | 1 | 0 | 0 | 100% |
| test_colcon_build_ms_airsim | 1 | 0 | 0 | 100% |
| test_colcon_build_robot | 1 | 0 | 0 | 100% |
| test_colcon_test_robot | 1 | 0 | 0 | 100% |
Metrics
| Test | Metric | Value |
|---|---|---|
| test_colcon_build_robot | duration_s | 101.8s |
| test_colcon_test_robot | duration_s | 40.82s |
| test_colcon_build_gcs | duration_s | 70.21s |
| test_colcon_build_ms_airsim | duration_s | 14.68s |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
simulation/ms-airsim/assets/scenes/**andsimulation/ms-airsim/environments/**toexclude_docsinmkdocs.yml.VERSION0.20.7 → 0.20.8 and record the change indocs/release_notes/index.md.unit-testsjob: teach the docs-catalog contract test's YAML loader the mkdocs!ENVtag that hotfix(docs): README-page 404s, link previews, edit-this-page button (0.20.7) #419 introduced (all fourtest_docs_catalog_contract.pytests had failed onmainanddevelopsince 2026-08-29).Why
The
same-dirplugin publishes the whole repo tree as site content. The downloaded Microsoft AirSim UE4 scenes and environments are gitignored but were not excluded from docs, so everymkdocs build/docs serveon a machine with scenes fetched copied ~15 GB of Unreal.debugbinaries and zips into the site directory. On one dev machine this had accumulated to ~70 GB across../siteand stale build dirs.No pages or links reference either directory (checked
mkdocs.ymlnav anddocs/).Verification
mkdocs.config.load_configloads the config; pattern match test:simulation/ms-airsim/assets/scenes/Blocks/LinuxNoEditor/Blocks.debugsimulation/ms-airsim/environments/AbandonedPark.zipsimulation/ms-airsim/docker/README.mddocs/simulation/ms-airsim/index.mdmkdocs buildwith the same two patterns on a machine with all four scenes plus AbandonedPark fetched: build output dropped from ~17–20 GB to ~2.5 GB, andsimulation/ms-airsim/assets/scenes/andsimulation/ms-airsim/environments/are absent from the output.pytest tests/meta/test_docs_catalog_contract.py: 4 failed → 15 passed.Supersedes #420 (head branch renamed to satisfy
enforce-branch-targets).🤖 Generated with Claude Code