Эта версия GitHub Enterprise Server будет прекращена 2026-08-25. Снятые релизы не поддерживаются. Исправления выпускаться не будут даже при критических проблемах безопасности. Для лучшей производительности, повышения безопасности и новых функций GitHub Enterprise Server см. Обзор процесса обновления. Для помощи с обновлением обращайтесь в GitHub Enterprise Support.

Тестирование файлов справки по запросу

Убедитесь, что ваши CodeQL файлы помощи по запросам корректны, предварительно просматривая их как Markdown.

Кто может использовать эту функцию?

CodeQL доступен для следующих типов репозитория:

В этой статье

Необходимые условия

  • Файлы помощи по запросу (.qhelp) должны содержать сопутствующие файлы запроса (.ql) с идентичными базовыми именами.
  • Файлы помощи по запросам должны соответствовать стандартной структуре и стилю документации по справке с запросами. Для получения дополнительной информации смотрите руководство по стилю помощи в запросе в репозитории CodeQL .

Предварительный просмотр файлов помощи по запросу

  1. Чтобы отобразить файлы помощи по запросу в виде Markdown, выполните следующую команду:

    Shell
    codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]

    Для получения информации о доступных опциях этой команды см. создание справки по запросу.

  2. Если вы получите предупреждающие сообщения, просмотрите их и исправите, затем запустите команду повторно. По умолчанию CodeQL CLI будет печататься предупреждающее сообщение, если:

    • Любая помощь по запросам некорректна
    • Все .qhelp файлы, указанные в команде, не имеют того же базового имени, что и сопровождающий .ql файл.
    • Все .ql файлы, указанные в команде, не имеют того же базового имени, что и сопровождающий .qhelp файл.

  3. Просмотрите отрендеренный Markdown в вашей выводной директории, файле или терминале, чтобы убедиться, что ваши файлы отображаются как ожидается.

Дополнительные материалы