Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#319 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@digitalresistor đang làm issue này rồi.

Từ ngày 20/10/2026.

  • #311 của @digitalresistor — đang mở

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
git, github-actions, python
Lĩnh vực
devops, tooling

Hướng nghiên cứu

Start by comparing tools/tfdoc.py and tools/check_documentation.py with the corresponding files in the tracked Cloud Foundation Fabric release, preserving the listed Python 3.11 and CodeQL fixes. Check the imports for tests/fixtures and tests/examples, then review tools/sync-from-cff.sh and tools/cff-sync.ignore. Done means the documentation check runs without the unknown fixture error, regenerated tables match the vendored READMEs, and the weekly sync covers these tools.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Documentation Enhancement Level of Effort - Medium Priority - Medium Scope - Module

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 #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

  • Keep the local script and accept table churn on every sync.
  • Run the upstream script from a Fabric checkout, as #311 did, which every maintainer would have to repeat by hand.

Additional Context

  • Related: #308 and #311.
Ngôn ngữ chính
HCL
Star
58
Fork
25
Merge trung bình
1 ngày 16 giờ
Pull request đã merge (30 ngày)
62

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của google/stellar-engine

Tất cả issue của google/stellar-engine

Issue tương tự

Thêm issue về DevOps

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.