Skip to main content

Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-12-19. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Creating CodeQL CLI database bundles

You can create a database bundle with CodeQL troubleshooting information.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de référentiels suivants :

Warning

CodeQL CLI database bundles contain a copy of the source code being analyzed by CodeQL, therefore we suggest sharing these bundles only with people who are authorized to access that source code.

About creating CodeQL CLI database bundles

Note

Cet article décrit les fonctionnalités disponibles avec le pack CodeQL CLI 2.14.6 inclus dans la mise en production initiale de GitHub Enterprise Server 3.11.

Si votre administrateur de site a mis à jour votre versionCodeQL CLI vers une version plus récente, consultez la version GitHub Enterprise Cloud de cet article pour obtenir plus d’informations sur les dernières fonctionnalités.

The CodeQL CLI database bundle command can be used to create a relocatable archive of a CodeQL database.

A copy of a database bundle can be used to share troubleshooting information with your team members or with Support GitHub.

The following CodeQL CLI command syntax is suggested when creating a database bundle for troubleshooting purposes:

Note

This sample database bundle command requires CodeQL CLI version 2.17.6 or higher.

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

For this command, <dir> must be the path to the directory where the CodeQL database was created.

The successful command execution creates a zip file called codeql-debug-artifacts.zip which contains CodeQL troubleshooting information. That file is the database bundle.

This command assumes that the --log-dir command line argument was not used for the database create and database analyze commands. When that command line argument is used, the log files created by those commands will not be included with the database bundle.

Increasing the verbosity for database create and database analyze

If the database create and database analyze commands are not detailed enough for troubleshooting purposes, you can increase their verbosity.

Both commands support the --verbosity command line argument which can be set to progress++ prior to creating a database bundle.