Github Pr Workflow
Жизненный цикл PR в GitHub: ветка, коммит, открытие, CI, слияние.
Метаданные навыка
| Источник | Встроенный (установлен по умолчанию) |
| Путь | skills/github/github-pr-workflow |
| Версия | 1.1.0 |
| Автор | VibeOS |
| Лицензия | MIT |
| Платформы | linux, macos, windows |
| Теги | GitHub, Pull-Requests, CI/CD, Git, Автоматизация, Слияние |
| Связанные навыки | github-auth, github-code-review |
Справочник: полный SKILL.md
Ниже приведено полное описание навыка, которое VibeOS загружает при его активации. Это те инструкции, которые видит агент, когда навык активен.
Рабочий процесс Pull Request в GitHub
Полное руководство по управлению жизненным циклом PR. В каждом разделе сначала показан способ с использованием gh, затем запасной вариант с git + curl для машин без gh.
Предварительные требования
- Аутентификация в GitHub (см. навык
github-auth) - Нахождение внутри git-репозитория с удалённым репозиторием на GitHub
Быстрая проверка аутентификации
# Определяем, какой метод использовать в этом рабочем процессе
if command -v gh &>/dev/null && gh auth status &>/dev/null; then
AUTH="gh"
else
AUTH="git"
# Убеждаемся, что у нас есть токен для API-запросов
if [ -z "$GITHUB_TOKEN" ]; then
if _vibeos_env="${VIBEOS_HOME:-$HOME/.vibeos}/.env"; [ -f "$_vibeos_env" ] && grep -q "^GITHUB_TOKEN=" "$_vibeos_env"; then
GITHUB_TOKEN=$(grep "^GITHUB_TOKEN=" "$_vibeos_env" | head -1 | cut -d= -f2 | tr -d '\n\r')
elif grep -q "github.com" ~/.git-credentials 2>/dev/null; then
GITHUB_TOKEN=$(grep "github.com" ~/.git-credentials 2>/dev/null | head -1 | sed 's|https://[^:]*:\([^@]*\)@.*|\1|')
fi
fi
fi
echo "Используется: $AUTH"
Извлечение владельца/репозитория из удалённого Git-репозитория
Многим командам curl требуется owner/repo. Извлекаем его из удалённого git-репозитория:
# Работает как для HTTPS, так и для SSH URL удалённых репозиториев
REMOTE_URL=$(git remote get-url origin)
OWNER_REPO=$(echo "$REMOTE_URL" | sed -E 's|.*github\.com[:/]||; s|\.git$||')
OWNER=$(echo "$OWNER_REPO" | cut -d/ -f1)
REPO=$(echo "$OWNER_REPO" | cut -d/ -f2)
echo "Владелец: $OWNER, Репозиторий: $REPO"
1. Создание ветки
Эта часть — чистый git — идентична в обоих случаях:
# Убеждаемся, что у нас актуальная версия
git fetch origin
git checkout main && git pull origin main
# Создаём и переключаемся на новую ветку
git checkout -b feat/add-user-authentication
Соглашения об именовании веток:
feat/описание— новые функцииfix/описание— исправления ошибокrefactor/описание— реструктуризация кодаdocs/описание— документацияci/описание— изменения в CI/CD
2. Создание коммитов
Используйте файловые инструменты агента (write_file, patch) для внесения изменений, затем сделайте коммит:
# Индексация конкретных файлов
git add src/auth.py src/models/user.py tests/test_auth.py
# Коммит с сообщением в соответствии с соглашением
git commit -m "feat: add JWT-based user authentication
- Add login/register endpoints
- Add User model with password hashing
- Add auth middleware for protected routes
- Add unit tests for auth flow"
Формат сообщения коммита (Conventional Commits):
type(scope): краткое описание
Более длинное объяснение при необходимости. Перенос на 72 символах.
Типы: feat, fix, refactor, docs, test, ci, chore, perf
3. Отправка и создание PR
Отправка ветки (одинаково в обоих случаях)
git push -u origin HEAD
Создание PR
С помощью gh:
gh pr create \
--title "feat: add JWT-based user authentication" \
--body "## Сводка
- Добавляет конечные точки API для входа и регистрации
- Генерация и проверка JWT-токенов
## План тестирования
- [ ] Модульные тесты проходят
Closes #42"
Опции: --draft, --reviewer user1,user2, --label "enhancement", --base develop
С помощью git + curl:
BRANCH=$(git branch --show-current)
curl -s -X POST \
-H "Authorization: token $GITHUB_TOKEN" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/$OWNER/$REPO/pulls \
-d "{
\"title\": \"feat: add JWT-based user authentication\",
\"body\": \"## Сводка\nДобавляет конечные точки API для входа и регистрации.\n\nCloses #42\",
\"head\": \"$BRANCH\",
\"base\": \"main\"
}"
Ответ JSON содержит number PR — сохраните его для последующих команд.
Чтобы создать черновик, добавьте "draft": true в тело JSON.
4. Мониторинг статуса CI
Проверка статуса CI
С помощью gh:
# Однократная проверка
gh pr checks
# Отслеживание до завершения всех проверок (опрос каждые 10 секунд)
gh pr checks --watch
С помощью git + curl:
# Получаем SHA последнего коммита в текущей ветке
SHA=$(git rev-parse HEAD)
# Запрос объединённого статуса
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/status \
| python3 -c "
import sys, json
data = json.load(sys.stdin)
print(f\"Общий: {data['state']}\")
for s in data.get('statuses', []):
print(f\" {s['context']}: {s['state']} - {s.get('description', '')}\")"
# Также проверяем запуски проверок GitHub Actions (отдельная конечная точка)
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/check-runs \
| python3 -c "
import sys, json
data = json.load(sys.stdin)
for cr in data.get('check_runs', []):
print(f\" {cr['name']}: {cr['status']} / {cr['conclusion'] or 'pending'}\")"
Опрос до завершения (git + curl)
# Простой цикл опроса — проверка каждые 30 секунд, до 10 минут
SHA=$(git rev-parse HEAD)
for i in $(seq 1 20); do
STATUS=$(curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/status \
| python3 -c "import sys,json; print(json.load(sys.stdin)['state'])")
echo "Проверка $i: $STATUS"
if [ "$STATUS" = "success" ] || [ "$STATUS" = "failure" ] || [ "$STATUS" = "error" ]; then
break
fi
sleep 30
done
5. Автоисправление ошибок CI
Когда CI завершается с ошибкой, диагностируйте и исправляйте. Этот цикл работает с любым методом аутентификации.
Шаг 1: Получение деталей ошибки
С помощью gh:
# Список последних запусков рабочих процессов в этой ветке
gh run list --branch $(git branch --show-current) --limit 5
# Просмотр журналов ошибок
gh run view <RUN_ID> --log-failed
С помощью git + curl:
BRANCH=$(git branch --show-current)
# Список запусков рабочих процессов в этой ветке
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
"https://api.github.com/repos/$OWNER/$REPO/actions/runs?branch=$BRANCH&per_page=5" \
| python3 -c "
import sys, json
runs = json.load(sys.stdin)['workflow_runs']
for r in runs:
print(f\"Запуск {r['id']}: {r['name']} - {r['conclusion'] or r['status']}\")"
# Получение журналов ошибочных заданий (скачать как zip, извлечь, прочитать)
RUN_ID=<run_id>
curl -s -L \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/actions/runs/$RUN_ID/logs \
-o /tmp/ci-logs.zip
cd /tmp && unzip -o ci-logs.zip -d ci-logs && cat ci-logs/*.txt
Шаг 2: Исправление и отправка
После выявления проблемы используйте файловые инструменты (patch, write_file) для её исправления:
git add <исправленные_файлы>
git commit -m "fix: resolve CI failure in <check_name>"
git push
Шаг 3: Проверка
Повторно проверьте статус CI, используя команды из раздела 4 выше.
Шаблон цикла автоисправления
При запросе на автоисправление CI следуйте этому циклу:
- Проверьте статус CI → определите ошибки
- Прочитайте журналы ошибок → поймите проблему
- Используйте
read_file+patch/write_file→ исправьте код git add . && git commit -m "fix: ..." && git push- Дождитесь CI → повторно проверьте статус
- Повторите, если ошибка всё ещё есть (до 3 попыток, затем спросите пользователя)
6. Слияние
С помощью gh:
# Squash-слияние + удаление ветки (самый чистый для функциональных веток)
gh pr merge --squash --delete-branch
# Включение автослияния (слияние после прохождения всех проверок)
gh pr merge --auto --squash --delete-branch
С помощью git + curl:
PR_NUMBER=<номер>
# Слияние PR через API (squash)
curl -s -X PUT \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/pulls/$PR_NUMBER/merge \
-d "{
\"merge_method\": \"squash\",
\"commit_title\": \"feat: add user authentication (#$PR_NUMBER)\"
}"
# Удаление удалённой ветки после слияния
BRANCH=$(git branch --show-current)
git push origin --delete $BRANCH
# Переключение обратно на main локально
git checkout main && git pull origin main
git branch -d $BRANCH
Методы слияния: "merge" (коммит слияния), "squash", "rebase"
Включение автослияния (curl)
# Автослияние требует, чтобы в настройках репозитория оно было включено.
# Здесь используется GraphQL API, так как REST не поддерживает автослияние.
PR_NODE_ID=$(curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/pulls/$PR_NUMBER \
| python3 -c "import sys,json; print(json.load(sys.stdin)['node_id'])")
curl -s -X POST \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/graphql \
-d "{\"query\": \"mutation { enablePullRequestAutoMerge(input: {pullRequestId: \\\"$PR_NODE_ID\\\", mergeMethod: SQUASH}) { clientMutationId } }\"}"
7. Полный пример рабочего процесса
# 1. Начинаем с чистой ветки main
git checkout main && git pull origin main
# 2. Ветка
git checkout -b fix/login-redirect-bug
# 3. (Агент вносит изменения в код с помощью файловых инструментов)
# 4. Коммит
git add src/auth/login.py tests/test_login.py
git commit -m "fix: correct redirect URL after login
Preserves the ?next= parameter instead of always redirecting to /dashboard."
# 5. Отправка
git push -u origin HEAD
# 6. Создание PR (выбирает gh или curl в зависимости от доступности)
# ... (см. Раздел 3)
# 7. Мониторинг CI (см. Раздел 4)
# 8. Слияние после успешных проверок (см. Раздел 6)
Справочник полезных команд PR
| Действие | gh | git + curl |
|---|---|---|
| Список моих PR | gh pr list --author @me | curl -s -H "Authorization: token $GITHUB_TOKEN" "https://api.github.com/repos/$OWNER/$REPO/pulls?state=open" |
| Просмотр diff PR | gh pr diff | git diff main...HEAD (локально) или curl -H "Accept: application/vnd.github.diff" ... |
| Добавить комментарий | gh pr comment N --body "..." | curl -X POST .../issues/N/comments -d '{"body":"..."}' |
| Запросить ревью | gh pr edit N --add-reviewer user | curl -X POST .../pulls/N/requested_reviewers -d '{"reviewers":["user"]}' |
| Закрыть PR | gh pr close N | curl -X PATCH .../pulls/N -d '{"state":"closed"}' |
| Переключиться на чужой PR | gh pr checkout N | git fetch origin pull/N/head:pr-N && git checkout pr-N |