Repository navigation
[Feature Request] Sync the repository tooling under tools/ from upstream Cloud Foundation Fabric #319
Copy link
Copy link
Open
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentationEnhancementNew feature or requestNew feature or requestLevel of Effort - MediumModerate task requiring thought and testing; typically takes a couple of days to a weekModerate task requiring thought and testing; typically takes a couple of days to a weekPriority - MediumStandard features and non-blocking bugs; important for the current milestone but not urgentStandard features and non-blocking bugs; important for the current milestone but not urgentScope - ModuleRelated to reusable Terraform modules in the modules directoryRelated to reusable Terraform modules in the modules directory
Description
Feature Description
Bring tools/tfdoc.py, tools/check_documentation.py and the related test helpers up to the upstream Cloud Foundation Fabric versions, so the README checks work again and regenerated tables match the vendored modules.
Use Case
- The
tools/tfdoc.pyscript predates Fabric v38.0.0 and was never synced, so it renders object types differently from the upstream script that generated the vendored module READMEs. - Regenerating a synced module README with the local script rewrites every table, so feat(modules)!: sync Cloud Foundation Fabric modules to v59.2.0 and add sync tooling #311 used the v59.2.0 upstream script from a Fabric checkout instead.
- The
tools/check_documentation.pycheck fails onmainwith anUnknown fixtureerror, so it cannot guard README tables today.
Proposed Solution
- Three-way merge the
tools/files from Fabric v38.0.0 to the release thatmodules/tracks, keeping the Stellar Engine changes such as the Python 3.11 and CodeQL fixes. - Vendor the
tests/fixturesandtests/exampleshelpers that the scripts import, or make the fixture lookup optional. - Extend
tools/sync-from-cff.shandtools/cff-sync.ignoreto cover the synced tool files, so the weekly sync keeps them current. - Run
tools/check_documentation.pyin CI once it passes.
Compliance & Deployment Context
- Target Deployment Type(s):
- US Region Restricted (e.g., Access Policy constraint)
- FedRAMP Moderate
- FedRAMP High
- DoD IL4
- DoD IL5
- All / General
- Relevant NIST 800-53r5 Controls: CM-2 baseline configuration
Reusability Check
Stellar Engine prioritizes reusability.
- I have checked if this functionality can be achieved by extending an existing module or blueprint.
- I have verified that this does not duplicate existing functionality.
Alternatives Considered
- Keep the local script and accept table churn on every sync.
- Run the upstream script from a Fabric checkout, as feat(modules)!: sync Cloud Foundation Fabric modules to v59.2.0 and add sync tooling #311 did, which every maintainer would have to repeat by hand.
Additional Context
Metadata
Metadata
Assignees
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentationEnhancementNew feature or requestNew feature or requestLevel of Effort - MediumModerate task requiring thought and testing; typically takes a couple of days to a weekModerate task requiring thought and testing; typically takes a couple of days to a weekPriority - MediumStandard features and non-blocking bugs; important for the current milestone but not urgentStandard features and non-blocking bugs; important for the current milestone but not urgentScope - ModuleRelated to reusable Terraform modules in the modules directoryRelated to reusable Terraform modules in the modules directory
Activity
chore(tools): sync the README tooling and test fixtures from Fabric v…
digitalresistor commentedon Oct 23, 2026
#311 now carries the README tooling sync for this issue: the
tools/tfdoc.pyandtools/check_documentation.pyscripts merged to Fabric v59.2.0, the vendoredtests/fixtures/files and the vendorednet-cloud-armormodule, which the sync script now tracks. With them,bash tools/lint.shpasses all 10 checks on that branch.chore(tools): sync the README tooling and test fixtures from Fabric v…