Введение
В этом руководстве показано, как использовать GitHub CLI в рабочем процессе, чтобы пометить только что открытые или вновь открытые проблемы. Например, метку triage
можно добавлять при каждом открытии или повторном открытии проблемы. Затем можно просмотреть все проблемы, которые необходимо уделить внимание, отфильтровав проблемы с меткой triage
.
GitHub CLI позволяет легко использовать API GitHub в рабочем процессе.
В руководстве сначала создайте файл рабочего процесса, использующий GitHub CLI. Затем вы настроите рабочий процесс в соответствии с вашими потребностями.
Создание рабочего процесса
-
Выберите репозиторий, в котором вы хотите применить этот рабочий процесс управления проектами. Вы можете использовать существующий репозиторий, к которому у вас есть доступ для записи, или создать репозиторий. Дополнительные сведения о создании репозитория см. в разделе "Создание репозитория".
-
В репозитории создайте файл с именем
.github/workflows/YOUR_WORKFLOW.yml
, гдеYOUR_WORKFLOW
— это любое имя на ваш выбор. Это файл рабочего процесса. Дополнительные сведения о создании новых файлов на сайте GitHub см. в разделе "Создание новых файлов". -
Скопируйте следующее содержимое YAML в файл рабочего процесса.
YAML name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - run: gh issue edit "$NUMBER" --add-label "$LABELS" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_REPO: ${{ github.repository }} NUMBER: ${{ github.event.issue.number }} LABELS: triage
name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - run: gh issue edit "$NUMBER" --add-label "$LABELS" env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_REPO: ${{ github.repository }} NUMBER: ${{ github.event.issue.number }} LABELS: triage
-
env
Настройте значения в файле рабочего процесса:- Значения
GH_TOKEN
иNUMBER
значения автоматически задаются с помощьюgithub
иsecrets
контекстов.GH_REPO
Изменить их не нужно. - В качестве значения для
LABELS
укажите список меток, которые вы хотите добавить к проблеме. Метки должны существовать для репозитория. Несколько меток следует разделять запятыми. Например,help wanted,good first issue
. Дополнительные сведения о метках см. в разделе "Управление метками".
- Значения
-
Зафиксируйте файл рабочего процесса в ветви по умолчанию вашего репозитория. Дополнительные сведения см. в разделе Создание новых файлов.
Тестирование рабочего процесса
При каждом открытии или повторном открытии проблемы в репозитории этот рабочий процесс будет добавлять к ней указанные метки.
Протестируйте рабочий процесс, создав проблему в репозитории.
- Создайте проблему в репозитории. Дополнительные сведения см. в разделе Создание проблемы.
- Чтобы просмотреть выполнение рабочего процесса, которое было активировано путем создания проблемы, просмотрите журнал выполнений рабочего процесса. Дополнительные сведения см. в разделе Просмотр журнала выполнения рабочего процесса.
- После завершения рабочего процесса к созданной проблеме должны быть добавлены указанные метки.
Следующие шаги
- Дополнительные сведения о дополнительных действиях, которые можно сделать с помощью GitHub CLI, см. в руководстве по интерфейсу командной строки GitHub.
- Дополнительные сведения о различных событиях, которые могут активировать рабочий процесс, см. в разделе "События, инициирующие рабочие процессы".
- Выполните поиск в GitHub , например рабочих процессов с помощью
gh issue edit
.