Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#319 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@digitalresistor ci sta già lavorando.

Dal 20/10/2026.

  • #311 di @digitalresistor — aperta

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
git, github-actions, python
Ambito
devops, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
HCL
Stelle
58
Fork
25
Merge medio
1g 17h
PR unite (30g)
60

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di google/stellar-engine

Tutte le issue di google/stellar-engine

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.