Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы, возможно, еще выполняется. Актуальные сведения см. в документации на английском языке.

Поддержка этой версии GitHub Enterprise будет прекращена 2023-03-15. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию GitHub Enterprise. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.

Автоматическое создание заметок о выпуске

Вы можете автоматически создавать заметки о выпуске для своих выпусков GitHub.

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

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

Сведения об автоматическом создании заметок о выпуске

Автоматическое создание заметок о выпуске — это альтернатива написанию заметок о выпуске на GitHub вручную. С помощью этой функции можно быстро создавать обзор содержимого выпуска. Автоматически созданные заметки о выпуске включают список объединенных запросов на вытягивание, список участников выпуска и ссылку на полный журнал изменений.

Автоматические заметки о выпуске можно также настроить с помощью меток, который позволяют создать пользовательские категории для упорядочения включаемых запросов на вытягивание. Кроме того, можно исключить определенные метки и пользователей из выходных данных.

Автоматическое создание заметок о выпуске для нового выпуска

  1. На экземпляр GitHub Enterprise Server перейдите на главную страницу репозитория. 1. Справа от списка файлов щелкните Выпуски. Раздел "Выпуски" на правой боковой панели
  2. Нажмите кнопку Создать черновик нового выпуска. Кнопка для создания черновика выпуска
  3. Введите номер версии для выпуска. Можно также выбрать существующий тег. Версия выпуска с тегом
  4. Если вы создали новый тег, в раскрывающемся меню выберите ветвь с проектом, который необходимо выпустить. Ветви с тегом
  5. В правом верхнем углу текстового поля описания щелкните Автоматически создать заметки о выпуске. Автоматически создать заметки о выпуске
  6. Проверьте созданные заметки, чтобы убедиться в том, что они содержат все сведения, которые необходимо включить, и ничего лишнего.
  7. Если в выпуск необходимо включить двоичные файлы, например скомпилированные программы, перетащите или вручную выберите файлы в области двоичных файлов. Предоставление DMG с выпуском
  8. Чтобы уведомить пользователей о том, что выпуск не готов к использованию в рабочей среде и может быть нестабильным, установите флажок Это предварительный выпуск. Флажок, помечающий выпуск как предварительный
  9. Если вы готовы опубликовать выпуск, нажмите кнопку Опубликовать выпуск. Чтобы продолжить работу с выпуском позже, нажмите кнопку Сохранить черновик. Кнопки "Опубликовать выпуск" и "Сохранить черновик"

Настройка автоматически созданных заметок о выпуске

  1. На экземпляр GitHub Enterprise Server перейдите на главную страницу репозитория. 1. Над списком файлов в раскрывающемся списке Добавить файл щелкните Создать файл. "Создать файл" в раскрывающемся списке "Добавить файл"
  2. В поле имени файла введите .github/release.yml, чтобы создать файл release.yml в каталоге .github. Создание файла
  3. Используя приведенные ниже параметры конфигурации, укажите в коде YAML файла метки запросов на вытягивание и авторов, которых следует исключить из этого выпуска. Вы также можете создать новые категории и перечислить метки запросов на вытягивание, которые должны быть включены в каждую из них.

Варианты настройки

ПараметрОписание
changelog.exclude.labelsСписок меток, исключающих запрос на вытягивание из заметок о выпуске.
changelog.exclude.authorsСписок дескрипторов входа пользователей или ботов, запросы на вытягивание которых должны быть исключены из заметок о выпуске.
changelog.categories[*].titleОбязательный. Название категории изменений в заметках о выпуске.
changelog.categories[*].labelsОбязательный. Метки, которые относят запрос на вытягивание к этой категории. Символу * будут соответствовать все запросы на вытягивание, которые не относятся ни к одной из предыдущих категорий.
changelog.categories[*].exclude.labelsСписок меток, исключающих запрос на вытягивание из данной категории.
changelog.categories[*].exclude.authorsСписок дескрипторов входа пользователей или ботов, запросы на вытягивание которых должны быть исключены из данной категории.

Примеры конфигураций

Конфигурация для репозитория, который помечает выпуски semver.

YAML
# .github/release.yml

changelog:
  exclude:
    labels:
      - ignore-for-release
    authors:
      - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - "*"

Конфигурация для репозитория, который не помечает запросы на вытягивание, но в котором мы хотим разделить автоматические запросы на вытягивание Dependabot в заметках о выпуске (labels: '*' требуется для отображения категории catchall).

YAML
# .github/release.yml

changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

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