Carta build board

Pipeline CI e deploy per repository: prima in errore, poi in esecuzione, in coda e passate, ciascuna con durata, chi l’ha avviata e quando.

Live card

Questa scheda viene disegnata nel browser con lo stesso codice usato dai Player, con dati di esempio.

Categoria: Operazioni. Tag: Avvisi e stato, Numeri e metriche, Uffici e luoghi di lavoro.

Layout

Questa scheda a schermo intero riempie tutto lo schermo in orizzontale o verticale e non è posizionata come angolo, chip o striscia.

Layout: pieno. Moduli: orizzontale, verticale.

Layout, temi e pubblicazione delle schede. Esplora le schede.

Dati e privacy

Feed: screenrig.builds/v1.

I documenti del feed riportano l’attribuzione della fonte. Il Player fornisce il feed alla scheda.

Proprietà

Per tema, sfondo, accento e posizione, vedi Proprietà comuni.

Imposta le proprietà statiche nei params della scheda quando la crei. Il suo documento dati contiene solo proprietà dinamiche. Le righe annidate descrivono il contenuto della proprietà genitore.

Proprietà statiche

NomeTipoPredefinitoValori e limitiDescrizione
titlestring"Builds"maxLength: 40
branchstring""maxLength: 60Mostra solo le corse in questo ramo; vuoto mostra ogni ramo.
showstring"all""all", "builds", "deploys"
staleMinutesinteger10minimo: 1; massimo: 1440I dati più vecchi di questo mostrano Aggiornato N min fa.
backgroundColorstringa, nullonullmodello: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Sovrascrive il colore di sfondo e della piastra della scheda con un colore piatto ordinato in CSS. #RRGGBBAA fornisce l’opacità. background none ha la precedenza.
textColorstringa, nullonullmodello: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Sovrascrive i colori del testo principale e secondario. I colori di accento e di stato semantico mantengono i loro ruoli.

Proprietà dinamiche

NomeTipoPredefinitoValori e limitiDescrizione
updatedAtstring""maxLength: 40Istante ISO 8601 in cui le pipeline sono state rilevate (solo archivio dati; un feed trasporta fetchedAt).
pipelinesarray[]maxItems: 60
pipelines[].idstring""maxLength: 60
pipelines[].namestringminLength: 1; maxLength: 60; ObbligatorioIl repository o pipeline.
pipelines[].branchstring""maxLength: 60
pipelines[].kindstring"build""build", "deploy"
pipelines[].environmentstring""maxLength: 30Dove va un deploy, per esempio produzione.
pipelines[].statusstring""maxLength: 24superato, fallito, in esecuzione, in coda o annullato. Si leggono anche: successo, riuscito, ok, verde, distribuito; fallimento, errore, rotto, rosso, scaduto; in corso, costruendo, distribuendo, iniziato; in attesa, aspettando, programmato; annullato, saltato, abortito. Qualsiasi altra parola mostra grigio come dato.
pipelines[].startedAtstring""maxLength: 40Istante ISO 8601 in cui la corsa è iniziata (corse in coda: quando sono state messe in coda). La durata di una pipeline in esecuzione parte da questo.
pipelines[].finishedAtstring""maxLength: 40Istante ISO 8601 in cui la corsa è terminata.
pipelines[].durationSecondsinteger0minimo: 0; massimo: 8640000La durata della corsa. Se omessa, è finishedAt meno startedAt.
pipelines[].actorstring""maxLength: 60Chi l’ha avviato o attivato.

Esempio di canvas

Salva le proprietà statiche come params.json e crea la scheda. Il risultato contiene il suo ID crd_.

{
  "theme": "neomustard"
}
screenrig card create --type build-board --major 1 --file params.json

Aggiungi questo elemento ai primitives di una pagina playlist, con quell’ID al posto di quello dell’esempio. Pubblica la playlist e assegna uno schermo.

{
  "id": "build-board",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Scrivere dati live

Scrivi il documento nella scheda dopo averla creata, poi sostituiscilo per aggiornare lo schermo senza ripubblicare. La scheda controlla ogni scrittura rispetto alle sue proprietà dinamiche e rifiuta un documento che non accetta. Usa lo stesso progetto della playlist.

Salva il documento come card-data.json. Il CLI legge il documento stesso, senza wrapper:

{
  "updatedAt": "",
  "pipelines": []
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Oppure chiamare direttamente l’API. L’API incapsula lo stesso documento in un campo document. Un token agente nomina già il suo progetto, quindi non viene inviato un header progetto; se invii ScreenRig-Project, deve corrispondere al progetto del token. Fornisci l’autorizzazione API tramite l’ambiente; vedi Autenticazione API.

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"updatedAt":"","pipelines":[]}}'