Как правильно назвать pr

[alxmcs]

В данном разделе описано, как корректно назвать свой pr, чтобы настроенный в репозитории github action успешно повесил на него теги и назначил ревьюера.

[alxmcs]

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

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

Рассмотрим работу github action на примере:

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

Номер группы и номер лабы указаны верно, так что акшон назначает ревьюера и вешает теги на pr:

Когда преподаватель назначается на ревью, ему падает оповещение на почту об этом.
Если ваш акшон не сработал корректно - падает оповещение на почту вам. Чтобы запустить акшон заново после внесения изменений в название pr, достаточно открыть и закрыть pr.

[alxmcs]

Github Action

Акшоны на гитхабе описываются при помощи yml-файлов, документацию по ним можно посмотреть тут.
На yml акшона в текущем репозитории можно взглянуть здесь.

Подробный разбор акшона для интересующихся:

---

В начале файла описывается название акшона, условия, при которых он срабатывает, и его права:

name: Setup PR for code review
on:
  pull_request_target:
    types: [opened, reopened]
permissions: write-all

В текущем случае, акшон назвается Setup PR for code review.
Срабатывает он при открытии и переоткрытии pr в исходный репозиторий.
Он имеет права на запись.

---

Далее перечисляются джобы акшона. Джоба - это набор последовательно исполняемых шагов. Джобы по умолчанию исполняются параллельно в независимых друг от друга средах.

jobs:
  assign:
    runs-on: ubuntu-latest    
    steps:

Наш акшон состоит из единственной джобы assign, эта джоба запускается в контейнере с ОС ubuntu.
Шаги, из которых состоит assign, разберем далее.

---

Первым шагом производится парсинг названия pr. Он должен содержать номер группы и номер лабы в формате Лаб.<номер от 1 до 7> или Лаб. <номер от 1 до 5>. Полученные при парсинге значения кладутся в переменные среды LABEL и GROUP.

     - name: Parsing your PR title for lab number
       env:
          TITLE: ${{ github.event.pull_request.title }}
       run: |
        SUB='Лаб.'
        for VAR in 1 2 3 4 5
        do
            if (echo $TITLE | grep -iqF "$SUB$VAR" )|| (echo $TITLE | grep -iqF "$SUB $VAR"); then
                echo "LABEL=Lab $VAR" >> "$GITHUB_ENV"
                break
            fi      
        done
        for VAR in 6411 6412 6413
        do
            if (echo $TITLE | grep -iqF "$VAR" ); then
                echo "GROUP=$VAR" >> "$GITHUB_ENV"
                break
            fi      
        done

---

Далее производится проверка переменной среды LABEL - если в нее не удалось распарсить значение из названия pr на предыдущем шаге, джоба и, соответственно, акшон завершается с ошибкой.

     - name: Checking your lab number
       run: |
        if [[ $LABEL == '' ]]; then
            echo "Your PR caption is not composed correctly"
            exit 1
        fi
        echo Your number was parsed correctly - ${{ env.LABEL }}

---

Аналогично производится проверка переменной GROUP.

     - name: Checking your group number
       run: |
        if [[ $GROUP == '' ]]; then
            echo "Your PR caption is not composed correctly"
            exit 1
        fi
        echo Your group was parsed correctly - ${{ env.GROUP }}

---

Далее на pr навешиваются лейблы при помощи акшона с маркетплейса github.

     - name: Setting PR labels
       uses: actions-ecosystem/action-add-labels@v1
       with:
        labels: |
           ${{ env.LABEL }}
           In progress

---

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

     - name: Setting reviewer 
       if:  env.GROUP == '6411'
       uses: AveryCameronUofR/add-reviewer-gh-action@1.0.3
       with:
          reviewers: "danlla"
          token: ${{ secrets.GITHUB_TOKEN }}
          
     - name: Setting reviewer
       if: env.GROUP == '6412' 
       uses: AveryCameronUofR/add-reviewer-gh-action@1.0.3
       with:
          reviewers: "alxmcs" 
          token: ${{ secrets.GITHUB_TOKEN }}
          
     - name: Setting reviewer
       if: env.GROUP == '6413' 
       uses: AveryCameronUofR/add-reviewer-gh-action@1.0.3
       with:
          reviewers: "DmitryKrakhmalev" 
          token: ${{ secrets.GITHUB_TOKEN }}

---

Как видно, ничего сложного тут нет.