Skip to main content

Códigos de saída

Os códigos de saída significam o status de um comando depois que a CodeQL CLI o executa.

Quem pode usar esse recurso?

O CodeQL do GitHub é licenciado por usuário após a instalação. Você pode usar o CodeQL somente para determinadas tarefas sob as restrições de licença. Para obter mais informações, confira "Sobre a CLI do CodeQL".

Se você tiver uma licença do GitHub Advanced Security, poderá usar o CodeQL para análise automatizada, integração contínua e entrega contínua. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

Sobre os códigos de saída

A CodeQL CLI relata o status de cada comando executado como um código de saída. Esse código de saída fornece informações para os próximos comandos ou para outras ferramentas que dependem da CodeQL CLI.

0

Êxito, término normal.

1

O comando determinou com sucesso que a resposta à pergunta é "Não".

Esse código de saída só é usado por alguns comandos, como "test run", "dataset check", "query format" e "resolve extractor". Para obter mais detalhes, confira a documentação desses comandos.

2

Algo deu errado.

A CLI grava uma mensagem de erro legível por pessoas no stderr. Isso inclui casos em que um extrator falha com um erro interno, porque o driver do codeql não consegue distinguir entre erros internos e voltados ao usuário no comportamento do extrator.

3

O inicializador não conseguiu localizar o diretório de instalação do CodeQL.

Nesse caso, o inicializador não pode iniciar o código Java para a CodeQL CLI. Isso só deve acontecer quando algo estiver muito errado com a instalação do CodeQL.

32

O extrator não encontrou nenhum código a ser analisado ao executar "database create" ou "database finalize".

33

Uma ou mais avaliações de consulta atingiu o tempo limite.

É possível que algumas consultas que foram avaliadas em paralelo não tenham atingido o tempo limite. Os resultados dessas consultas são produzidos como de costume.

98

A avaliação foi cancelada explicitamente.

99

A CodeQL CLI ficou sem memória.

Isso não significa necessariamente que toda a RAM física do computador tenha sido usada. Se você não usar a opção --ram para definir um limite explicitamente, a JVM escolherá um limite padrão na inicialização.

100

Ocorreu um erro fatal interno.

Isso deve ser considerado um bug. A CLI geralmente grava uma descrição de erro abreviada no stderr. Se você puder reproduzir o bug, será útil usar --logdir e enviar os arquivos de log para GitHub em um relatório de bugs.

Outro

No caso de problemas realmente graves na JVM que executa o codeql, pode ser retornado um código de saída diferente de zero escolhido. Isso só deve acontecer se houver algo muito errado com a instalação do CodeQL ou se houver algum problema de memória com o sistema host que executa o processo do CodeQL. Por exemplo, os sistemas Unix podem retornar o Código de Saída 137 para indicar que o kernel encerrou um processo que o CodeQL iniciou. Uma forma de solucionar isso é modificar o sinalizador –ram= da etapa codeql database analyze e executar novamente o fluxo de trabalho.