Skip to content

[Feature Request] Sync the repository tooling under tools/ from upstream Cloud Foundation Fabric #319

Open

Description

@digitalresistor

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.py script 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.py check fails on main with an Unknown fixture error, so it cannot guard README tables today.

Proposed Solution

  • Three-way merge the tools/ files from Fabric v38.0.0 to the release that modules/ tracks, keeping the Stellar Engine changes such as the Python 3.11 and CodeQL fixes.
  • Vendor the tests/fixtures and tests/examples helpers that the scripts import, or make the fixture lookup optional.
  • Extend tools/sync-from-cff.sh and tools/cff-sync.ignore to cover the synced tool files, so the weekly sync keeps them current.
  • Run tools/check_documentation.py in 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

Additional Context

Activity

  1. added
    DocumentationImprovements or additions to documentation
    EnhancementNew feature or request
    Priority - MediumStandard features and non-blocking bugs; important for the current milestone but not urgent
    Level of Effort - MediumModerate task requiring thought and testing; typically takes a couple of days to a week
    Scope - ModuleRelated to reusable Terraform modules in the modules directory
    and removed on Oct 20, 2026
  2. added a commit that references this issue on Oct 23, 2026
    68921e2
  3. digitalresistor commented on Oct 23, 2026

    @digitalresistor
    ContributorAuthor

    #311 now carries the README tooling sync for this issue: the tools/tfdoc.py and tools/check_documentation.py scripts merged to Fabric v59.2.0, the vendored tests/fixtures/ files and the vendored net-cloud-armor module, which the sync script now tracks. With them, bash tools/lint.sh passes all 10 checks on that branch.

  4. added a commit that references this issue on Oct 28, 2026
    bb38166
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentationEnhancementNew feature or requestLevel of Effort - MediumModerate 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 urgentScope - ModuleRelated to reusable Terraform modules in the modules directory

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions