Funcionalidade docs_check - BrunodosSantosVaz/big-bang GitHub Wiki
Verificação de Markdown e entrada
Funcionalidade BB-F-009 · requisito RF-BB-009 · versão documentada 2.0.1 · código 9c73feb3e357a1216011eaf64bf4b5d944827087.
Finalidade
Detectar cercas abertas, links locais inválidos e ausência da apresentação, comunidade ou ícone necessários ao sistema.
Atores
Pessoa responsável pelo projeto, IA com posse confirmada e automações explicitamente autorizadas.
Pré-condições
Repositório e raiz corretos, versão instalada e configuração compatível. Para operações de escrita, exige-se autorização vigente, branch adequada e acesso ao recurso envolvido; consultas não conferem permissão adicional.
Fluxo principal
Percorrer documentos locais permitidos, verificar navegação; em público exigir README breve, Wiki, Discussions e painéis; validar o manifesto canônico.
Validações
Privados preservam README completo e arquivos locais; público não pode entregar documentos de sistema duplicados.
Alternativas e erros
Links quebrados, README incompatível ou cobertura ausente geram problemas que fazem a CI falhar.
Permissões
Leitura usa permissões mínimas do repositório. Operações locais respeitam a posse e worktree; escrita no GitHub exige acesso explícito. Esta funcionalidade não concede novas permissões a visitantes nem substitui decisões exigidas pelo fluxo.
Resultados
Resultado esperado: Detectar cercas abertas, links locais inválidos e ausência da apresentação, comunidade ou ícone necessários ao sistema. O retorno e os arquivos afetados são conferidos pelos cenários rastreados abaixo; falha impede considerar a operação concluída.
Referência da implementação
Os símbolos abaixo compõem o inventário real do módulo, incluindo auxiliares internos; não representam APIs públicas independentes.
docs_check.py
| Símbolo | Linha |
|---|---|
outside_code |
18 |
anchor |
36 |
anchors |
43 |
broken_links |
56 |
markdown_files |
73 |
has_release |
89 |
readme_problems |
98 |
community_problems |
139 |
problems |
152 |
Cenários e rastreabilidade
.bigbang/tests/test_readme_sistema.py:test_antes_da_primeira_release_nao_cobra.bigbang/tests/test_readme_sistema.py:test_completo_passa.bigbang/tests/test_readme_sistema.py:test_ainda_na_fundacao_ou_a_preencher_reprova.bigbang/tests/test_readme_sistema.py:test_falta_secao_e_selo.bigbang/tests/test_readme_sistema.py:test_comentario_do_modelo_nao_conta.bigbang/tests/test_readme_sistema.py:test_modelo_tem_todas_as_secoes.bigbang/tests/test_readme_sistema.py:test_sem_bigbang_toml_nao_se_aplica.bigbang/tests/test_readme_sistema.py:test_cobra_os_arquivos_de_comunidade.bigbang/tests/test_readme_sistema.py:test_icone_depois_do_design_ou_da_release.bigbang/tests/test_readme_sistema.py:test_modelos_existem
Requisitos · Matriz de rastreabilidade · Referência CLI