Documentação das Ferramentas da Pipeline de Segurança
Descrição
Documentar as ferramentas selecionadas e integradas na pipeline de segurança, incluindo configurações, uso e exemplos práticos.
Ferramentas Implementadas
- Gitleaks - Detecção de segredos
- Semgrep - Análise estática (SAST)
- pip-audit - Vulnerabilidades em dependências Python
- Trivy - Scan de filesystem, dependências e configurações
Checklist de Documentação
Documentação Básica
-
Criar visão geral da pipeline de segurança -
Explicar integração entre as ferramentas -
Incluir diagrama simples do fluxo
Por Ferramenta
-
Gitleaks - configuração e exemplos -
Semgrep - regras e configurações -
pip-audit - setup e uso -
Trivy - scanners configurados
⚙️ Configuração Prática
-
Trechos relevantes do .gitlab-ci.yml -
Variáveis de ambiente necessárias -
Exemplos de arquivos de configuração
Uso e Troubleshooting
-
Como interpretar resultados -
Processo para falsos positivos -
Exemplos de resolução de problemas
Critérios de Aceitação
-
Documentação em Markdown -
Exemplos práticos incluídos -
Instruções claras e reproduzíveis -
Revisada por um membro da equipe
Labels: documentação, pipeline-segurança
Assignee: @caroll_mf
Edited by Ana Fialho