Skip to content

Latest commit

 

History

History
225 lines (164 loc) · 10.9 KB

README_RUS.md

File metadata and controls

225 lines (164 loc) · 10.9 KB

Github action - изменение состояния задачи на доске Яндекс Трекера

ENG

Использовать экшен

Мотивация

Яндекс Трекер не имеет (на текущий момент) автоматизации по изменению состояния задачи, над которой работает разработчик.

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

Экшен может передвигать задачу в два состояния:

  • Открытый Pull Request - “На ревью”
  • Смерженный Pull Request - “Смержено”

У каждой задачи есть свой бизнес-процесс или состояние, в котором она может находиться

transitions

Когда разработчик открывает Pull Request, задача автоматически перемещается в состояние “На ревью”, даже, если разработчик не взял ее в работу

review

После успешного прохождения ревью задача перемещается в состояние “Смержено”

Работа с экшеном

Создайте в репозитории файл .github/workspace/task-transition.yaml следующего содержания (далее разберем подробно со всеми обязательными и опциональными параметрами):

name: YC Tracker
on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - closed

jobs:
  validate-rules-and-move-task:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.sha }}

      # Выполняется, когда PR октрыт
      - name: Move Task When PR Opened
        if: github.event.action != 'closed'
        uses: evrone-erp/yandex-tracker-action@v1
        with:
          token: ${{secrets.GITHUB_TOKEN}}
          yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
          yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}

      # Выполняется, когда PR смержен
      - name: Move Task When PR Merged
        if: github.event.pull_request.merged == true
        uses: evrone-erp/yandex-tracker-action@v1
        with:
          token: ${{secrets.GITHUB_TOKEN}}
          yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
          yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}

Выше мы видим, что экшен вызывается два раза

  • когда PR открыт
  • когда PR смержен

Что происходит, когда вы открываете PR

В ранее созданном файле task-transition.yaml можно указать номер задачи или несколько задач, разделенных запятыми, которые необходимо двигать на доске

- name: Move Task When PR Opened
  if: github.event.action != 'closed'
  uses: evrone-erp/yandex-tracker-action@v1
  with:
    token: ${{secrets.GITHUB_TOKEN}}
    yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
    yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}
    tasks: ERP-11,ERP-12 # можно указать номера задач

Помимо этого в процессе работы на PR, если был сделан коммит с номером задачи, отличным от указанного в tasks, он так же будет обработан.

Важно Задачи из коммитов забираются из []. Например, "[DI-118] fix something". Если подытожить наши знания, то задачи для обработки будут: ERP-11,ERP-12,DI-118.

Если вы используете другой подход в коммитах и не указаываете номера задач в [], то такие коммиты будут игнорироваться. В этом случае, вы можете добавить новую задачу в tasks файла task-transition.yaml.

Собранные задачи будут переведены в статус "На ревью" и в PR, а так же в сами задачи, будут добавлены соответсвующие комментарии (ниже примеры).

В описание PR будут добавлены ссылки на задачи в трекере:

pr description

Если вы не хотите обновлять описание в PR удалите или переключите инпут task_url в false в файле task-transition.yaml

- name: Move Task When PR Opened
  if: github.event.action != 'closed'
  uses: evrone-erp/yandex-tracker-action@v1
  with:
    token: ${{secrets.GITHUB_TOKEN}}
    yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
    yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}
    task_url: false # или удалите этот инпут. Значение по-умолчанию false

Игнорирование задач

Часто бывают задачи с долгим жизненным циклом. Например, ежедневные созвоны или сопровождение проектов. В этом случае мы можем хотеть игнорировать эти задачи, чтобы они не двигались на доске. Укажите номера задач в файле task-transition.yaml в инпуте ignore:

- name: Move Task When PR Opened
  if: github.event.action != 'closed'
  uses: evrone-erp/yandex-tracker-action@v1
  with:
    token: ${{secrets.GITHUB_TOKEN}}
    yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
    yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}
    ignore: ERPOPS-7,EPR-21 # какие задачи игнорировать

Указать состояние задачи

По-умолчанию, при открытом PR задачи перемещаются в состояние "На ревью". При смерженом - "Решено".

Если необходимо перемещать задачу в отличное состояние, то можно указать это состояние в файле task-transition.yaml в инпуте to:

- name: Move Task When PR Opened
  if: github.event.action != 'closed'
  uses: evrone-erp/yandex-tracker-action@v1
  with:
    token: ${{secrets.GITHUB_TOKEN}}
    yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
    yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}
    to: testing # или Тестирование - важно! Имя должно существовать в бизнес-процессе переходов задачи

Если задача не существует

В этом случае она будет проигнорирована и вы сможете увидеть в выводе работы экшена сообщение об этом

WARNING! TASK E-9000 NOT FOUND

Если задача уже на ревью или состояние для задачи не найдено

Сообщение:

ERPOPS-10 NOTHING TO DO. AVAILABLE TRANSITIONS IS: {'resolve': 'Решить', 'ready_for_test': 'Можно тестировать', 'need_info': 'Нужна информация', 'close': 'Закрыть'}

Если задача обновлена

В выводе экшена можно увидеть сообщение:

ERPOPS-9 TASK UPDATED

Так же в самом теле PR будет сообщение:

pr message

Сообщение в задаче:

task message

Мерж PR

Для смерженого PR действуют те же правила, что и для открытого. По-умолчанию, смерженный PR передвигается в "resolve". Если необходимо перемещать задачу в другое состояние, укажите инпут to в файле task-transition.yaml:

- name: Move Task When PR Merged
  if: github.event.pull_request.merged == true
  uses: evrone-erp/yandex-tracker-action@v1
  with:
    token: ${{secrets.GITHUB_TOKEN}}
    yandex_org_id: ${{ secrets.YANDEX_ORG_ID }}
    yandex_oauth2_token: ${{ secrets.YANDEX_OAUTH2_TOKEN }}
    to: merged

Доступные инпуты

action.yaml

Обязательные параметры

  • token: Обязательно Токен Github.
  • yandex_oauth2_token: Обязательно Токен Yandex oauth2. Вам необходимо зарегистрировать приложение OAUTH2, а затем получить токен пользователя. Документация.
  • yandex_org_id: Обязательно Идентификатор организации, зарегистрированной в Yandex Tracker.
  • is_yandex_cloud_org: Опционально Если к Трекеру применяется только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
  • ignore: Опционально Игнорируемые задачи, разделенные запятыми.
  • tasks: Опционально Ключ задачи, которую нужно переместить на доску.
  • task_url: Опционально Значение по умолчанию - false. Установите в true, если вы хотите прокомментировать PR с URL задачи.
  • to: Опционально Укажите, куда вы хотите переместить задачу. По умолчанию - in_review для открытых PR и resolve для закрытых PR.

Документация по получению OAUTH2 токена от Яндекс

yandex-tracker-action проект создан и поддержан Evrone