Skip to main content

​
Configurações Principais

Kodus possui três níveis de configuração: Global, Repositório e Diretório. Saiba como funcionam em Herança e Sobrescrita de Configuração.

​
Prioridade de Configuração

Você pode manter a configuração de revisão em um arquivo kodus-config.yml na raiz do repositório, em vez de usar a interface web.
O arquivo é ignorado até você habilitar essa opção. Por padrão, kodusConfigFileOverridesWebPreferences é false, ou seja, o Kody nunca lê o kodus-config.yml — só fazer commit do arquivo não surte efeito nenhum.Habilite primeiro em Settings → Code Review → o repositório → General, ou defina kodusConfigFileOverridesWebPreferences: true no nível de repositório (ou diretório) pela interface web. Só então o arquivo passa a valer.
Uma vez habilitado, o arquivo é mesclado por cima das configurações web: você só precisa declarar as chaves que quer mudar — tudo que for omitido mantém o valor definido na web.
Chaves desconhecidas são descartadas silenciosamente. Qualquer chave de primeiro nível que não faça parte do schema atual é removida antes de a configuração ser aplicada — sem erro e sem aviso. Se alguma configuração parecer não fazer efeito, confira a grafia contra o exemplo abaixo.
Este exemplo espelha os padrões que já vêm configurados. A fonte canônica é o default-kodus-config.yml no repositório kodus-ai.

​
Comportamento de Revisão

​
Revisão Automatizada

Kody pode revisar PRs automaticamente quando abertos, ou apenas quando você comentar @kody start-review.
Isso afeta apenas a revisão inicial. Para commits subsequentes, veja Cadência de Revisão abaixo.

​
Cadência de Revisão

Como Kody lida com revisões em commits subsequentes:
Revisa cada novo push. Feedback contínuo sobre todas as alterações.

​
Fluxo do PR

​
Auto-aprovar PRs

Kody aprova PRs quando nenhum problema é encontrado. Plataformas: GitHub, GitLab, Bitbucket

​
Solicitar Alterações

Kody solicita alterações ao encontrar problemas críticos. Plataformas: GitHub, Bitbucket

​
Condições de Pulo

Arquivos Ignorados: Use padrões glob (ex.: **/*.js), um por linha. Padrão: yarn.lock, package-lock.json, package.json, .env, **/*.json Títulos Ignorados: Pule PRs com palavras-chave específicas (sem distinção de maiúsculas/minúsculas, máx. 100 caracteres) Branches Base: Restringe quais branches de destino são revisadas.
Vazio (o padrão) significa que toda branch de destino é revisada — não existe uma lista embutida de dev/release/master. Adicione entradas apenas quando quiser restringir o escopo: com a lista preenchida, o Kody revisa somente PRs direcionados àquelas branches (a branch padrão do repositório sempre entra junto).As entradas são comparadas com a branch de destino do PR e aceitam uma sintaxe própria:Quando várias entradas correspondem, vence a mais específica. Cada entrada tem limite de 100 caracteres, só pode usar a-z A-Z 0-9 / * - _ ! = :, e ** não é permitido.
PRs em rascunho: runOnDraft é true por padrão, então rascunhos são revisados. Defina como false para pular esses PRs até serem marcados como prontos.

​
Tipos de Análise

O Kody revisa em quatro categorias. Habilite ou desabilite cada uma em Analysis Types, ou pelo reviewOptions no kodus-config.yml.
  • Bug — erros de lógica, race conditions, null dereferences, edge cases e comportamento incorreto.
  • Security — vulnerabilidades, injeção, problemas de autenticação, exposição de dados e secrets.
  • Performance — queries N+1, alocações em hot path, ausência de cache e I/O bloqueante.
  • Business Logic — valida a implementação contra regras de negócio, requisitos e critérios de aceite vinculados ao PR. Veja Validação de Regras de Negócio.
Kody Rules não é uma dessas categorias — elas sempre rodam, independentemente de reviewOptions. Veja Kody Rules.