Сведения об автоматическом создании заметок о выпуске
Автоматическое создание заметок о выпуске — это альтернатива написанию заметок о выпуске на GitHub вручную. С помощью этой функции можно быстро создавать обзор содержимого выпуска. Автоматически созданные заметки о выпуске включают список объединенных запросов на вытягивание, список участников выпуска и ссылку на полный журнал изменений.
Автоматические заметки о выпуске можно также настроить с помощью меток, который позволяют создать пользовательские категории для упорядочения включаемых запросов на вытягивание. Кроме того, можно исключить определенные метки и пользователей из выходных данных.
Автоматическое создание заметок о выпуске для нового выпуска
- На экземпляр GitHub Enterprise Server перейдите на главную страницу репозитория. 1. Справа от списка файлов щелкните Выпуски.
- Нажмите кнопку Создать черновик нового выпуска.
- Введите номер версии для выпуска. Можно также выбрать существующий тег.
- Если вы создали новый тег, в раскрывающемся меню выберите ветвь с проектом, который необходимо выпустить.
- В правом верхнем углу текстового поля описания щелкните Автоматически создать заметки о выпуске.
- Проверьте созданные заметки, чтобы убедиться в том, что они содержат все сведения, которые необходимо включить, и ничего лишнего.
- Если в выпуск необходимо включить двоичные файлы, например скомпилированные программы, перетащите или вручную выберите файлы в области двоичных файлов.
- Чтобы уведомить пользователей о том, что выпуск не готов к использованию в рабочей среде и может быть нестабильным, установите флажок Это предварительный выпуск.
- Если вы готовы опубликовать выпуск, нажмите кнопку Опубликовать выпуск. Чтобы продолжить работу с выпуском позже, нажмите кнопку Сохранить черновик.
Настройка автоматически созданных заметок о выпуске
- На экземпляр GitHub Enterprise Server перейдите на главную страницу репозитория. 1. Над списком файлов в раскрывающемся списке Добавить файл щелкните Создать файл.
- В поле имени файла введите
.github/release.yml, чтобы создать файлrelease.ymlв каталоге.github.
- Используя приведенные ниже параметры конфигурации, укажите в коде YAML файла метки запросов на вытягивание и авторов, которых следует исключить из этого выпуска. Вы также можете создать новые категории и перечислить метки запросов на вытягивание, которые должны быть включены в каждую из них.
Варианты настройки
| Параметр | Описание |
|---|---|
changelog.exclude.labels | Список меток, исключающих запрос на вытягивание из заметок о выпуске. |
changelog.exclude.authors | Список дескрипторов входа пользователей или ботов, запросы на вытягивание которых должны быть исключены из заметок о выпуске. |
changelog.categories[*].title | Обязательный. Название категории изменений в заметках о выпуске. |
changelog.categories[*].labels | Обязательный. Метки, которые относят запрос на вытягивание к этой категории. Символу * будут соответствовать все запросы на вытягивание, которые не относятся ни к одной из предыдущих категорий. |
changelog.categories[*].exclude.labels | Список меток, исключающих запрос на вытягивание из данной категории. |
changelog.categories[*].exclude.authors | Список дескрипторов входа пользователей или ботов, запросы на вытягивание которых должны быть исключены из данной категории. |
Примеры конфигураций
Конфигурация для репозитория, который помечает выпуски semver.
# .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).
# .github/release.yml
changelog:
categories:
- title: 🏕 Features
labels:
- '*'
exclude:
labels:
- dependencies
- title: 👒 Dependencies
labels:
- dependencies