Documentação do Guardrail Ledger
O gate e as exceções
O gate decide se um pull request passa. Uma exceção impede que uma descoberta aceite o faça falhar, até a exceção expirar.
Definir o gate
Um proprietário ou administrador abre a página Gates e define:
- A severidade mais baixa que faz falhar um pull request: critical, high, medium ou low. Os novos espaços de trabalho começam em high.
- Os motores que contam para o gate. Todos os scanners continuam a correr e todas as descobertas são registadas. As descobertas de um motor que não está na lista não fazem falhar o gate.
- O limite de contribuidores, contado como requerentes de compilação únicos ao longo de 30 dias. O gate acrescenta um item em falha quando mais pessoas do que o limite executaram compilações.
Escolha Guardar. A alteração do gate é escrita no registo de auditoria.
Ler o resultado
Cada execução responde com o resultado do gate. Quando o gate bloqueia, a chamada de ingestão responde com o estado 409 e o passo ou job falha, a menos que defina failOnGate: false na tarefa ou fail-on-gate: false na Action. O resultado também é escrito no comentário do pull request e, no GitHub, no resumo do job. As descobertas ficam em Findings com o repositório e o pull request em que foram encontradas.
Uma análise resolve apenas as descobertas dos motores que reportaram nela. Uma descoberta que deixa de aparecer é marcada como resolvida.
Registar uma exceção
- Um proprietário ou administrador abre a página Exceptions.
- Escolha uma descoberta em aberto, ou cole a sua impressão digital.
- Escolha o responsável, um membro do espaço de trabalho que não seja você. Você fica registado como aprovador.
- Escreva o motivo e defina a validade, no máximo 90 dias a partir de hoje.
- Escolha Registar exceção. Aplica-se de imediato.
Uma descoberta com exceção não faz falhar o gate. Depois da data de validade, a análise seguinte volta a contá-la para o gate. A consola não tem botão para revogar uma exceção.