Skip to content

Commit

Permalink
tech: add job to update release-notes (#7431)
Browse files Browse the repository at this point in the history
    Добавил job для вызова скрипта для обновления release-notes
    Настроил последовательное выполнение job-ы
    Настроил permissions
    Обновил шаблон pull request-а, добавил пункт в чеклист по заполнению release notes, а также описал формат заполнения
  • Loading branch information
EldarMuhamethanov authored Sep 2, 2024
1 parent 4b77d8a commit 1872249
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [ ] e2e-тесты
- [ ] Дизайн-ревью
- [ ] Документация фичи
- [ ] Release notes

## Описание

Expand All @@ -29,3 +30,43 @@
Если всё прозрачно, то игнорируй этот заголовок.
-->

## Release notes

<!--
Необходимо описать основные изменения, которые будут отображены в release notes релиза, в который попадет задача
Формат следующий:
- Изменения нужно сгруппировать в секции. Можно указать несколько секций, порядок не важен. Секция должна быть заголовом второго уровня (`## ${заголовок}`). Ниже список секций
- Новые компоненты
- Улучшения
- Исправления
- Документация
- Зависимости
- В каждой секции нужно указать список изменений
- Каждый пункт изменений должен начинаться с '-'
- Если изменение касается какого-то конкретного компонента, то его название должно быть указано и отделено от описания через ':'
Пример:
> - CustomSelect: поправлен баг с неправильным позиционированием
или
> - [CustomSelect](https://vkcom.github.io/VKUI/${version}/#/CustomSelect): поправил баг с неправильным позиционированием
- Если изменений по одному компоненту несколько, их нужно указать в следующем формате
> - CustomSelect:
> - Поправлен баг с позиционированием
> - Добавлен новый props
- Если изменение не касается конкретного компонента, то его нужно также указать через '-' и далее в свободной форме
Пример:
> - Переделан механизм отображения всех модальных окон
- Для каждого пункта можно добавить дополнительную информацию. Ее можно указать на следующей строке после описания изменения
Пример:
> ## Новые компоненты
> - Button: компонент, для отображения кнопок
> Более подробное описание
> {Картинка нового компонента}
-->
26 changes: 26 additions & 0 deletions .github/workflows/pr_close.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,29 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
pull_request_number: ${{ steps.create_pull_request.outputs.pull-request-number }}

update-release-notes:
if: ${{ github.event.pull_request.merged == true
&& github.event.pull_request.base.ref == 'master'}}
runs-on: ubuntu-latest
name: Update release notes
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.base.ref }}
cancel-in-progress: false
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Get vkui version
id: get_version
run: |
echo "vkui_version=$(node -p "require('./packages/vkui/package.json').version")" >> $GITHUB_OUTPUT
- name: Update release notes script
uses: VKCOM/gh-actions/VKUI/auto-update-release-notes@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
vkui_version: ${{ steps.get_version.outputs.vkui_version }}
pull_request_number: ${{ github.event.pull_request.number }}

0 comments on commit 1872249

Please sign in to comment.