Комментирование проблемы, к которой добавлена метка

Введение

В этом руководстве показано, как использовать GitHub CLI для комментариев о проблеме при применении определенной метки. Например, если к проблеме добавлена метка help wanted, можно добавить комментарий, чтобы пригласить участников к работе над проблемой. Дополнительные сведения о GitHub CLIсм. в разделе Использование GitHub CLI в рабочих процессах.

В руководстве сначала вы создайте файл рабочего процесса, использующий gh issue comment команду для комментариев о проблеме. Затем вы настроите рабочий процесс в соответствии с вашими потребностями.

Создание рабочего процесса

1. Выберите репозиторий, в котором вы хотите применить этот рабочий процесс управления проектами. Вы можете использовать существующий репозиторий, к которому у вас есть доступ для записи, или создать репозиторий. Дополнительные сведения о создании репозитория см. в разделе "Создание репозитория".

2. В репозитории создайте файл с именем .github/workflows/YOUR_WORKFLOW.yml, где YOUR_WORKFLOW — это любое имя на ваш выбор. Это файл рабочего процесса. Дополнительные сведения о создании новых файлов на сайте GitHub см. в разделе "Создание новых файлов".

3. Скопируйте следующее содержимое YAML в файл рабочего процесса.

   YAML

   name: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help wanted'
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - name: Add comment
           run: gh issue comment "$NUMBER" --body "$BODY"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             BODY: >
               This issue is available for anyone to work on.
               **Make sure to reference this issue in your pull request.**
               :sparkles: Thank you for your contribution! :sparkles:
   

4. Настройте параметры в файле рабочего процесса.

   • Замените help wanted в if: github.event.label.name == 'help wanted' меткой, в соответствии с которой требуется выполнять определенное действие. Если вы хотите работать в соответствии с несколькими метками, разделите условия с помощью ||. Например, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' будет добавлять комментарий при каждом добавлении меток bug или fix me к проблеме.
   • Измените значение BODY на комментарий, который нужно добавить. Поддерживается GitHub Flavored Markdown. Дополнительные сведения о markdown см. в разделе Базовый синтаксис записи и форматирования.

5. Зафиксируйте файл рабочего процесса в ветви по умолчанию вашего репозитория. Дополнительные сведения см. в разделе Создание новых файлов.

Тестирование рабочего процесса

Этот рабочий процесс будет выполняться при каждом добавлении метки к проблеме в репозитории. Если добавленная метка является одной из меток, указанных в файле рабочего процесса, gh issue comment команда добавит комментарий, указанный в проблеме.

Протестируйте рабочий процесс, применив указанную метку к проблеме.

1. Откройте проблему в репозитории. Дополнительные сведения см. в разделе Создание проблемы.
2. Добавьте к проблеме указанную метку в файле рабочего процесса. Дополнительные сведения см. в разделе Управление метками.
3. Чтобы просмотреть выполнение рабочего процесса, которое было активировано путем применения метки к проблеме, просмотрите журнал выполнений рабочего процесса. Дополнительные сведения см. в разделе Просмотр журнала выполнения рабочего процесса.
4. Когда рабочий процесс завершится, к помеченной проблеме должен быть добавлен комментарий.

Следующие шаги

• Дополнительные сведения о дополнительных возможностях с помощью интерфейса командной строки GitHub, например редактирования существующих комментариев, см. в руководстве по интерфейсу командной строки GitHub.