Config schema does not describe the tagFormat and docs.group rules

Aperta Adatta ai principianti
  • Qualcosa non va?
#97 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
76/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
json, typescript
Ambito
documentation, tooling

Direzione di ricerca

Leggi schema/nanoforge.schema.json insieme alle regole di convalida in src/lib/config.ts, concentrandoti su tagFormat e docs.group. Aggiungi vincoli allo schema laddove possano essere espressi come pattern e descrizioni per le regole tra campi. Il lavoro è completato quando la convalida nell’editor e la documentazione dello schema riflettono le regole di runtime elencate.

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

Descrizione

documentation good first issue
What is the type of issue?

Documentation is missing

What is the issue?

schema/nanoforge.schema.json doesn't describe the rules parseConfig (src/lib/config.ts) enforces, so an editor validating against the schema accepts configs the actions reject at runtime:

  • tagFormat must contain {version}, can't use {packages} or {run}, must contain {package} in an independent group, and can only use {package} in a shared group of one package (mode single);
  • docs.group must name a shared group.

Some of these can be a pattern; the cross-field ones at least belong in the descriptions.

Found by the quality gate of the v3 rework, branch feat/v3-shared-workflows (commit 4617e86, not pushed yet when this was filed).

Where did you find it?

schema/nanoforge.schema.json (tagFormat and docs.group)

Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
15h 51m
PR unite (30g)
21

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 NanoForge-dev/actions

Tutte le issue di NanoForge-dev/actions

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.