Github Pr Workflow
目次
- skill の情報
- 参考: SKILL.md 全文
- 事前に必要なもの
- 認証方法をすばやく見分ける
- git のリモートから owner/repo を取り出す
- 1. ブランチを作る
- 2. コミットする
- 3. push して PR を作る
- ブランチを push する(どちらの方法でも同じです)
- PR を作る
- 4. CI の状態を見る
- CI の状態を確かめる
- 終わるまで繰り返し確かめる(git + curl)
- 5. CI の失敗を自動で直す
- 手順1: 失敗の内容を取り出す
- 手順2: 直して push する
- 手順3: 確認する
- 自動で直すときの繰り返し方
- 6. マージする
- 自動マージを有効にする(curl)
- 7. ひととおりの流れの例
- よく使う PR コマンドの早見表
GitHub の PR の一生をたどります。ブランチ、コミット、作成、CI、マージまでです。
skill の情報
| 提供元 | 最初から入っています |
| パス | skills/github/github-pr-workflow |
| バージョン | 1.1.0 |
| 作者 | Hermes Agent |
| ライセンス | MIT |
| 対応プラットフォーム | linux, macos, windows |
| タグ | GitHub, Pull-Requests, CI/CD, Git, Automation, Merge |
| 関連 skill | github-auth, github-code-review |
参考: SKILL.md 全文
GitHub の Pull Request の進め方
PR の一生をひととおり管理するための手引きです。どの節も gh を使うやり方を先に示し、そのあとに gh が入っていない端末向けの git + curl のやり方を示します。
事前に必要なもの
- GitHub の認証が済んでいること(
github-authskill を参照してください) - GitHub のリモートを持つ git リポジトリの中にいること
認証方法をすばやく見分ける
# Determine which method to use throughout this workflow
if command -v gh &>/dev/null && gh auth status &>/dev/null; then
AUTH="gh"
else
AUTH="git"
# Ensure we have a token for API calls
if [ -z "$GITHUB_TOKEN" ]; then
if _hermes_env="${HERMES_HOME:-$HOME/.hermes}/.env"; [ -f "$_hermes_env" ] && grep -q "^GITHUB_TOKEN=" "$_hermes_env"; then
GITHUB_TOKEN=$(grep "^GITHUB_TOKEN=" "$_hermes_env" | head -1 | cut -d= -f2 | tr -d '\n\r')
elif grep -q "github.com" ~/.git-credentials 2>/dev/null; then
GITHUB_TOKEN=$(uv run python3 "${HERMES_HOME:-$HOME/.hermes}/skills/github/github-auth/scripts/git-credential-token.py")
fi
fi
fi
echo "Using: $AUTH"git のリモートから owner/repo を取り出す
curl を使うコマンドの多くは owner/repo を必要とします。git のリモートから取り出します。
# Works for both HTTPS and SSH remote URLs
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: $OWNER, Repo: $REPO"1. ブランチを作る
ここは純粋な git だけで、どちらの方法でも同じです。
# Make sure you're up to date
git fetch origin
git checkout main && git pull origin main
# Create and switch to a new branch
git checkout -b feat/add-user-authenticationブランチ名の付け方:
feat/description— 新しい機能fix/description— バグ修正refactor/description— コードの整理docs/description— ドキュメントci/description— CI/CD の変更
2. コミットする
エージェントのファイル操作ツール(write_file、patch)で変更を加えてから、コミットします。
# Stage specific files
git add src/auth.py src/models/user.py tests/test_auth.py
# Commit with a conventional commit message
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): short description
Longer explanation if needed. Wrap at 72 characters.種類: feat, fix, refactor, docs, test, ci, chore, perf
3. push して PR を作る
ブランチを push する(どちらの方法でも同じです)
git push -u origin HEADPR を作る
gh を使う場合:
gh pr create \
--title "feat: add JWT-based user authentication" \
--body "## Summary
- Adds login and register API endpoints
- JWT token generation and validation
## Test Plan
- [ ] Unit tests pass
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\": \"## Summary\nAdds login and register API endpoints.\n\nCloses #42\",
\"head\": \"$BRANCH\",
\"base\": \"main\"
}"返ってくる JSON には PR の number が含まれます。あとのコマンドで使うので控えておきます。
下書きとして作りたいときは、JSON の本文に "draft": true を足します。
4. CI の状態を見る
CI の状態を確かめる
gh を使う場合:
# One-shot check
gh pr checks
# Watch until all checks finish (polls every 10s)
gh pr checks --watchgit + curl を使う場合:
# Get the latest commit SHA on the current branch
SHA=$(git rev-parse HEAD)
# Query the combined status
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/status \
| python3 -c "
data = json.load(sys.stdin)
print(f\"Overall: {data['state']}\")
for s in data.get('statuses', []):
print(f\" {s['context']}: {s['state']} - {s.get('description', '')}\")"
# Also check GitHub Actions check runs (separate endpoint)
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/check-runs \
| python3 -c "
data = json.load(sys.stdin)
for cr in data.get('check_runs', []):
print(f\" {cr['name']}: {cr['status']} / {cr['conclusion'] or 'pending'}\")"終わるまで繰り返し確かめる(git + curl)
# Simple polling loop — check every 30 seconds, up to 10 minutes
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 "Check $i: $STATUS"
if [ "$STATUS" = "success" ] || [ "$STATUS" = "failure" ] || [ "$STATUS" = "error" ]; then
break
fi
sleep 30
done5. CI の失敗を自動で直す
CI が失敗したら、原因を調べて直します。この繰り返しは、どちらの認証方法でも同じように使えます。
手順1: 失敗の内容を取り出す
gh を使う場合:
# List recent workflow runs on this branch
gh run list --branch $(git branch --show-current) --limit 5
# View failed logs
gh run view <RUN_ID> --log-failedgit + curl を使う場合:
BRANCH=$(git branch --show-current)
# List workflow runs on this branch
curl -s \
-H "Authorization: token $GITHUB_TOKEN" \
"https://api.github.com/repos/$OWNER/$REPO/actions/runs?branch=$BRANCH&per_page=5" \
| python3 -c "
runs = json.load(sys.stdin)['workflow_runs']
for r in runs:
print(f\"Run {r['id']}: {r['name']} - {r['conclusion'] or r['status']}\")"
# Get failed job logs (download as zip, extract, read)
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: 直して push する
原因が分かったら、ファイル操作ツール(patch、write_file)で直します。
git add <fixed_files>
git commit -m "fix: resolve CI failure in <check_name>"
git push手順3: 確認する
第4節のコマンドで CI の状態をもう一度確かめます。
自動で直すときの繰り返し方
CI の自動修正を頼まれたら、次を繰り返します。
- CI の状態を確かめ、失敗している箇所を見つけます
- 失敗ログを読み、エラーの内容を理解します
read_fileとpatch/write_fileでコードを直しますgit add . && git commit -m "fix: ..." && git push- CI を待って、状態をもう一度確かめます
- まだ失敗するなら繰り返します(3回まで。それでも駄目ならユーザーに相談します)
6. マージする
gh を使う場合:
# Squash merge + delete branch (cleanest for feature branches)
gh pr merge --squash --delete-branch
# Enable auto-merge (merges when all checks pass)
gh pr merge --auto --squash --delete-branchgit + curl を使う場合:
PR_NUMBER=<number>
# Merge the PR via 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)\"
}"
# Delete the remote branch after merge
BRANCH=$(git branch --show-current)
git push origin --delete $BRANCH
# Switch back to main locally
git checkout main && git pull origin main
git branch -d $BRANCHマージの方式: "merge"(マージコミット)、"squash"、"rebase"
自動マージを有効にする(curl)
# Auto-merge requires the repo to have it enabled in settings.
# This uses the GraphQL API since REST doesn't support auto-merge.
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. Start from clean main
git checkout main && git pull origin main
# 2. Branch
git checkout -b fix/login-redirect-bug
# 3. (Agent makes code changes with file tools)
# 4. Commit
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. Push
git push -u origin HEAD
# 6. Create PR (picks gh or curl based on what's available)
# ... (see Section 3)
# 7. Monitor CI (see Section 4)
# 8. Merge when green (see Section 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" |
| 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 |