Montar placa cartão

Pipelines e implantações CI por repositório: primeiro com falha, depois em execução, em fila e aprovados, cada um com sua duração, quem iniciou e quando.

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Operações. Etiquetas: Alertas e status, Números e métricas, Escritórios e locais de trabalho.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Feed: screenrig.builds/v1.

Documentos do feed carregam atribuição da fonte. O Player fornece o feed para o cartão.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

NomeTipoPadrãoValores e limitesDescrição
titlestring"Builds"maxLength: 40
branchstring""maxLength: 60Mostra apenas execuções neste ramo; vazio mostra todos os ramos.
showstring"all""all", "builds", "deploys"
staleMinutesinteger10mínimo: 1; máximo: 1440Dados mais antigos que este mostram Atualizado há N min.
backgroundColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
textColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

NomeTipoPadrãoValores e limitesDescrição
updatedAtstring""maxLength: 40Instante ISO 8601 em que os pipelines foram obtidos (apenas armazenamento de dados; um feed carrega fetchedAt).
pipelinesarray[]maxItems: 60
pipelines[].idstring""maxLength: 60
pipelines[].namestringminLength: 1; maxLength: 60; ObrigatórioO repositório ou pipeline.
pipelines[].branchstring""maxLength: 60
pipelines[].kindstring"build""build", "deploy"
pipelines[].environmentstring""maxLength: 30Onde um deploy vai, por exemplo produção.
pipelines[].statusstring""maxLength: 24aprovado, reprovado, em execução, na fila ou cancelado. Também lido como: sucesso, bem-sucedido, ok, verde, implantado; falha, erro, quebrado, vermelho, tempo esgotado; em andamento, construindo, implantando, iniciado; pendente, aguardando, agendado; cancelado, pulado, abortado. Qualquer outra palavra aparece cinza conforme fornecido.
pipelines[].startedAtstring""maxLength: 40Instante ISO 8601 em que a execução começou (execuções na fila: quando foram enfileiradas). A duração de um pipeline em execução conta a partir dele.
pipelines[].finishedAtstring""maxLength: 40Instante ISO 8601 em que a execução terminou.
pipelines[].durationSecondsinteger0mínimo: 0; máximo: 8640000A duração da rodada. Se omitida, é finishedAt menos startedAt.
pipelines[].actorstring""maxLength: 60Quem iniciou ou acionou.

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

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

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

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

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

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

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":[]}}'