Přeskočit na obsah

npm run intake:validate-form — Strukturální kontrola issue formulářů

Strukturální kontrola issue formulářů: Kontroluje malou množinu strukturálních vlastností .github/ISSUE_TEMPLATE/*.yml a config.yml, které by jinak tiše rozbily skutečné odeslání. npm skript, validace vstupů.

npm skript validace vstupů shodí běh

Volání

npm run intake:validate-form

Spustí node scripts/ci/validate-issue-forms.mjs (čteno z package.json při buildu)

Zdroj: scripts/ci/validate-issue-forms.mjs

Kontroluje malou množinu strukturálních vlastností .github/ISSUE_TEMPLATE/*.yml a config.yml, které by jinak tiše rozbily skutečné odeslání. Není to reimplementace celého GitHub schema validátoru — to by bylo znovuvynalezení existujícího nástroje.

Kdy ho spustit

Po editaci issue šablon. Do npm test je zapojený přes vlastní test soubor, takže vlastní krok pipeline nepotřebuje.

Co shodí běh

  • Nevalidní YAML nebo tabulátory v šabloně.
  • Neunikátní id polí.
  • Pole bez atributů, které jeho typ vyžaduje.
  • Vadný tvar config.yml.

Co je potřeba vědět

  • Hlubší kontrakt formulář ↔ parser („parsuje výstup tohohle formuláře doopravdy?“) vlastní scripts/intake/issue-form-compatibility.test.mjs, ne tenhle skript.

Vstupy a výstupy

Čte

  • .github/ISSUE_TEMPLATE/*.yml
  • .github/ISSUE_TEMPLATE/config.yml

Popis vychází z hlavičkového komentáře zdrojového souboru. Volání, zařazení do pipeline i členství v pre-commit hooku se dopočítávají při každém buildu ze samotného repozitáře.