Автоматизация заметок о выпуске с помощью GitHub

5 мин

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

Вы можете создать обзор содержимого выпуска, а также настроить автоматические заметки о выпуске.

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

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

При настройке выпуска вы увидите параметр автоматического создания заметок о выпуске, чтобы включить все изменения между тегом и последним выпуском. Если вы никогда не создавали выпуск, в него войдут все изменения из вашего репозитория.

Снимок экрана, показывающий, как создать заметки о выпуске из GitHub.

Вы можете выбрать, хотите ли вы настроить его или оставить его как есть.

Настройка шаблона автоматически сгенерированных примечаний к выпуску

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

Перейдите к репозиторию и создайте новый файл.
Имя .github/release.yml можно использовать для создания файла release.yml в каталоге .github.
Укажите в YAML метки pull request и авторов, которых вы хотите исключить из этого релиза. Вы также можете создавать новые категории и перечислять метки для запросов на pull request в каждой из них. Дополнительные сведения о параметрах конфигурации см. в автоматически созданных заметках о выпуске в документации GitHub.

Пример конфигурации :
```
# .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:
        - *
```
Сохраните новый файл.
Попробуйте создать новый выпуск и нажмите + Автоматически сгенерировать заметки о выпуске, чтобы просмотреть структуру шаблона.

Дополнительные сведения см. в следующем разделе:

Автоматизация заметок о выпуске с помощью GitHub

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

Настройка шаблона автоматически сгенерированных примечаний к выпуску

Обратная связь