Skip to main content

Criar pacotes de banco de dados da CLI do CodeQL

Você pode criar um pacote de banco de dados com informações de solução de problemas do CodeQL.

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

Warning

Os pacotes de banco de dados do CodeQL CLI contêm uma cópia do código-fonte que está sendo analisado por CodeQL, portanto, sugerimos compartilhar esses pacotes apenas com pessoas autorizadas a acessar esse código-fonte.

Sobre a criação de pacotes de banco de dados do CodeQL CLI

Note

Este artigo descreve os recursos disponíveis com o pacote CodeQL CLI 2.20.3 incluído na versão inicial do GitHub Enterprise Server 3.15.

Se o administrador do site atualizou a versão do CodeQL CLI para uma mais recente, confira a versão GitHub Enterprise Cloud deste artigo para obter informações sobre os recursos mais recentes.

O comando de pacote de banco de dados do CodeQL CLI pode ser usado para criar um arquivo relocável de um banco de dados CodeQL.

Uma cópia de um pacote de banco de dados pode ser usada para compartilhar informações de solução de problemas com os membros da equipe ou com o Suporte do GitHub.

A seguinte sintaxe de comando da CodeQL CLI é sugerida ao criar um pacote de banco de dados para fins de solução de problemas:

Note

Este comando de exemplo database bundle requer a versão da CodeQL CLI 2.17.6 ou superior.

codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

Para esse comando, <dir> deve ser o caminho para o diretório em que o banco de dados CodeQL foi criado.

A execução de comando bem-sucedida cria um arquivo zip chamado codeql-debug-artifacts.zip que contém informações de solução de problemas do CodeQL. Esse arquivo é o pacote de banco de dados.

Esse comando pressupõe que o argumento de linha de comando --log-dir não foi usado para os comandos database create e database analyze. Quando esse argumento de linha de comando for usado, os arquivos de log criados por esses comandos não serão incluídos com o pacote de banco de dados.

Aumentar o detalhamento para database create e database analyze

Se os comandos database create e database analyze não forem detalhados o suficiente para fins de solução de problemas, você poderá aumentar o detalhamento.

Ambos os comandos dão suporte ao argumento de linha de comando --verbosity que pode ser definido como progress++ antes de criar um pacote de banco de dados.