Введение
В этом руководстве показано, как использовать действие peter-evans/create-or-update-comment
для комментирования проблемы, к которой применена определенная метка. Например, если к проблеме добавлена метка help-wanted
, можно добавить комментарий, чтобы пригласить участников к работе над проблемой.
В этом руководстве вы сначала создадите файл рабочего процесса, использующий действие peter-evans/create-or-update-comment
. Затем вы настроите рабочий процесс в соответствии с вашими потребностями.
Создание рабочего процесса
-
Выберите репозиторий, в котором вы хотите применить этот рабочий процесс управления проектами. Вы можете использовать существующий репозиторий, к которому у вас есть доступ для записи, или создать репозиторий. Дополнительные сведения о создании репозитория см. в разделе "Создание репозитория".
-
В репозитории создайте файл с именем
.github/workflows/YOUR_WORKFLOW.yml
, гдеYOUR_WORKFLOW
— это любое имя на ваш выбор. Это файл рабочего процесса. Дополнительные сведения о создании новых файлов на сайте GitHub см. в разделе "Создание новых файлов". -
Скопируйте следующее содержимое YAML в файл рабочего процесса.
YAML # Этот рабочий процесс использует действия, которые не сертифицированы GitHub. # Они предоставляются сторонним поставщиком, и на них распространяются # отдельные условия обслуживания, политика конфиденциальности и поддержка # документации. # GitHub рекомендует закрепить действия в фиксации SHA. # Чтобы получить более новую версию, потребуется обновить SHA. # Вы также можете ссылаться на тег или ветвь, однако действие может измениться без предупреждения. 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 uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f with: issue-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:
# Этот рабочий процесс использует действия, которые не сертифицированы GitHub. # Они предоставляются сторонним поставщиком, и на них распространяются # отдельные условия обслуживания, политика конфиденциальности и поддержка # документации. # GitHub рекомендует закрепить действия в фиксации SHA. # Чтобы получить более новую версию, потребуется обновить SHA. # Вы также можете ссылаться на тег или ветвь, однако действие может измениться без предупреждения. 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 uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f with: issue-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:
-
Настройте параметры в файле рабочего процесса.
- Замените
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 см. в разделе "Базовый синтаксис записи и форматирования".
- Замените
-
Зафиксируйте файл рабочего процесса в ветви по умолчанию вашего репозитория. Дополнительные сведения см. в разделе "Создание новых файлов".
Тестирование рабочего процесса
Этот рабочий процесс будет выполняться при каждом добавлении метки к проблеме в репозитории. Если добавленная метка является одной из указанных в файле рабочего процесса, действие peter-evans/create-or-update-comment
добавит к проблеме указанный комментарий.
Протестируйте рабочий процесс, применив указанную метку к проблеме.
- Откройте проблему в репозитории. Дополнительные сведения см. в разделе «AUTOTITLE».
- Добавьте к проблеме указанную метку в файле рабочего процесса. Дополнительные сведения см. в разделе «AUTOTITLE».
- Чтобы просмотреть выполнение рабочего процесса, которое было активировано путем применения метки к проблеме, просмотрите журнал выполнений рабочего процесса. Дополнительные сведения см. в разделе «AUTOTITLE».
- Когда рабочий процесс завершится, к помеченной проблеме должен быть добавлен комментарий.
Следующие шаги
- Дополнительные сведения о задачах, которые можно выполнить с помощью действия
peter-evans/create-or-update-comment
, например добавление реакций, см. в документации по действиюpeter-evans/create-or-update-comment
.