Skip to main content

Generating regular expressions for custom patterns with AI

You can use the AI-powered Генератор регулярных выражений to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.

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

Владельцы репозитория, владелец организации, руководители безопасности и пользователи с ролью администратора

Generating a regular expression for a repository with AI

Примечание.

Подписка на GitHub Copilot не требуется для использования Секретное сканирование Copilot's Генератор регулярных выражений. Функции Секретное сканирование Copilot доступны для репозиториев, принадлежащих организациям и предприятиям с включенным параметром GitHub Secret Protection.

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. В разделе "Безопасность" боковой панели щелкните Advanced Security.

  4. Under "Secret Protection", under "Custom patterns", click New pattern.

  5. В поле "Имя шаблона" введите имя шаблона.

  6. В правом верхнем углу нажмите кнопку "Создать с помощью ИИ".

    Примечание.

    Регулярное выражение можно ввести вручную вместо использования генератора, введя регулярное выражение для формата шаблона секрета в поле "Секретный формат". Дополнительные сведения см. в разделе "Определение пользовательского шаблона для репозитория " или "Определение пользовательского шаблона для организации".

  7. На скользящей панели, которая отображается:

    • Заполните поле "Я хочу регулярного выражения, которое", описывающее, в идеале в обычном английском языке, какие шаблоны вы хотите записать регулярное выражение. Вы можете использовать другие естественные языки, но производительность может быть не так хороша, как и на английском языке.

    • Заполните поле "Примеры того, что я ищу", указав пример шаблона, на который вы хотите проверить.

    • Нажмите кнопку "Создать предложения".

    • При необходимости щелкните предложение, чтобы просмотреть описание регулярного выражения.

    • Нажмите кнопку "Использовать результаты" в появившемся разделе "Результаты ", чтобы получить нужный результат.

      Снимок экрана: заполненная пользовательская форма secret scanning для используемого генератора.

  8. Вы можете нажать «Больше опций », чтобы предоставить другой сопутствующий контент или дополнительные требования к совпадению для секретного формата. GitHub добавит примеры, введенные на скользящей панели, в поле "Строка теста ".

  9. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.

  10. По завершении пробного запуска вы увидите выборку результатов (до 1000). Проверьте результаты и определите ложноположительные. Снимок экрана: результаты сухого запуска.

  11. Измените новый пользовательский шаблон, чтобы устранить все проблемы с результатами, а затем, чтобы протестировать изменения, щелкните Сохранить и выполнить пробный запуск.

  12. Когда вы удовлетворены новым пользовательским шаблоном, нажмите кнопку "Опубликовать шаблон".

Можно настроить secret scanning для проверки отправки пользовательских шаблонов перед объединением фиксаций в ветвь по умолчанию. Дополнительные сведения см. в разделе "Включение защиты push-уведомлений" для пользовательского шаблона.

Generating a regular expression for an organization with AI

  1. В правом верхнем углу GitHub, щелкните рисунок профиля, а затем выберите октикона "организация" aria-hidden="true" aria-label="organization" %} Ваши организации.

  2. Выберите организацию, кликнув по ней.

  3. Под именем организации щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: вкладки в профиле организации. Вкладка "Параметры" выделена темно-оранжевым цветом.

  4. В разделе "Безопасность" боковой панели щелкните Advanced Security затем глобальные параметры.

  5. В разделе «Пользовательские выкройки» нажмите « Новая выкройка».

  6. В поле "Имя шаблона" введите имя шаблона.

  7. В правом верхнем углу нажмите кнопку "Создать с помощью ИИ".

    Примечание.

    Регулярное выражение можно ввести вручную вместо использования генератора, введя регулярное выражение для формата шаблона секрета в поле "Секретный формат". Дополнительные сведения см. в разделе "Определение пользовательского шаблона для репозитория " или "Определение пользовательского шаблона для организации".

  8. На скользящей панели, которая отображается:

    • Заполните поле "Я хочу регулярного выражения, которое", описывающее, в идеале в обычном английском языке, какие шаблоны вы хотите записать регулярное выражение. Вы можете использовать другие естественные языки, но производительность может быть не так хороша, как и на английском языке.

    • Заполните поле "Примеры того, что я ищу", указав пример шаблона, на который вы хотите проверить.

    • Нажмите кнопку "Создать предложения".

    • При необходимости щелкните предложение, чтобы просмотреть описание регулярного выражения.

    • Нажмите кнопку "Использовать результаты" в появившемся разделе "Результаты ", чтобы получить нужный результат.

      Снимок экрана: заполненная пользовательская форма secret scanning для используемого генератора.

  9. Вы можете нажать «Больше опций », чтобы предоставить другой сопутствующий контент или дополнительные требования к совпадению для секретного формата. GitHub добавит примеры, введенные на скользящей панели, в поле "Строка теста ".

  10. When you're ready to test your new custom pattern, to identify matches in selected repositories without creating alerts, click Save and dry run.

  11. Выберите репозитории, в которых требуется выполнить пробное выполнение.

    • Чтобы выполнить пробное выполнение во всей организации, щелкните Все репозитории в организации.
    • Чтобы указать репозитории, в которых требуется выполнить пробное выполнение, щелкните Выбранные репозитории, а затем найдите и выберите до 10 репозиториев.
  12. Когда вы будете готовы протестировать новый пользовательский шаблон, щелкните Выполнить.

  13. По завершении пробного запуска вы увидите выборку результатов (до 1000). Проверьте результаты и определите ложноположительные. Снимок экрана: результаты сухого запуска.

  14. Измените новый пользовательский шаблон, чтобы устранить все проблемы с результатами, а затем, чтобы протестировать изменения, щелкните Сохранить и выполнить пробный запуск.

  15. Когда вы удовлетворены новым пользовательским шаблоном, нажмите кнопку "Опубликовать шаблон".

Можно настроить secret scanning для проверки отправки пользовательских шаблонов перед объединением фиксаций в ветвь по умолчанию. Дополнительные сведения см. в разделе "Включение защиты push-уведомлений" для пользовательского шаблона.

Further reading