Pular para o conteúdo
AnchorsAnchors
EN · PT

Gate: docs-covered

Every spec reaches some documentation page.

Propriedade Valor
Verificação docs-covered
Confronta spec
Bloqueante por padrão — projeto novo sim
Bloqueante por padrão — projeto existente não — informa

Como declarar

Seção intitulada “Como declarar”
gates:
  - name: docs-covered
    on: [spec]
    check: docs-covered

Fonte: verificação · sua spec (em inglês)

🎯 O que este gate mede?

Seção intitulada “🎯 O que este gate mede?”

Garante que toda spec alcança alguma página da documentação compilada.

Em termos simples: este gate garante que o seu software não cometa erros por descuido ou falta de sincronização. Se você ou uma inteligência artificial alterar um arquivo coberto por este gate, ele inspeciona o trabalho imediatamente.

🛡️ Por que isso é importante?

Seção intitulada “🛡️ Por que isso é importante?”

Impede especificações esquecidas que nunca aparecem no portal de documentação do projeto.

Sem este gate ativo, esse tipo de defeito passa despercebido pelos testes comuns e só estoura em produção ou durante refatorações dolorosas semanas depois.

⚙️ Como funciona por baixo dos panos?

Seção intitulada “⚙️ Como funciona por baixo dos panos?”

Verifica se a spec está indexada no sumário ou em alguma página gerada da documentação.

Condições dos Vereditos:

Seção intitulada “Condições dos Vereditos:”
  • ✓ Pass (Aprovado): A spec aparece na documentação compilada.
  • ✗ Fail (Reprovado): Spec não referenciada na documentação.
  • ~ Indeterminado/Pending: Não se aplica.
  • Skip (Dispensado): Não se aplica.

📋 Exemplo de Configuração no anchors.yaml

Seção intitulada “📋 Exemplo de Configuração no anchors.yaml”

Para ativar este gate no seu projeto, adicione o bloco abaixo na seção gates: do seu anchors.yaml:

gates:
  - name: docs-covered
    blocking: false
    measures: "toda spec alcança alguma página da documentação compilada"

💡 Recomendações de Uso

Seção intitulada “💡 Recomendações de Uso”
  • Quando ativar: Informativo para publicação de portais de documentação.
  • Fase de execução: Configure em when: [pre-commit, ci] para verificações rápidas, ou when: [pre-push, ci] para gates que rodam ferramentas mais pesadas.
  • Transição de maturidade: Comece com blocking: false para avaliar o estado atual do repositório com anchors check. Quando zerar as ocorrências, altere para blocking: true.

🔧 Como corrigir quando este gate reprovar?

Seção intitulada “🔧 Como corrigir quando este gate reprovar?”

Se o anchors check acusar falha (✗) neste gate:

  1. Inclua a spec no índice de documentação ou execute anchors docs build.
  2. Reexecute a verificação no terminal:
    Terminal window
    anchors check
  3. Se o gate suportar correção automática, você pode tentar o comando:
    Terminal window
    anchors check --fix

🔗 Conceitos Relacionados

Seção intitulada “🔗 Conceitos Relacionados”