GitHub Agentic Workflowsでドキュメントの自動更新をやってみる
コンサルティング部の吉井です。
GitHub Agentic Workflowsというサービスがテクニカルプレビューになっていたので、実際に触ってみた内容をまとめてみます。
GitHub Agentic Workflowsとは
GitHub Agentic WorkflowsはGitHub Actions の中で AI コーディングエージェントを動かせる仕組みです。
.mdファイルにAIに対しての指示を自然言語で記述し、GitHub Actions用のyamlにコンパイルすることでワークフローを定義することができます。公式の説明では既存のCI/CDに置き換わるものではなく、それらに追加される新しい自動化レイヤーとして説明されています。たとえば、Issue を振り分けたり、ドキュメントを書いたり、依存関係を調べたり、レビューしやすいようにコードの改善案を出したりするような、再現性をそこまで強く求めないタスクはGitHub Agentic Workflowsのユースケースのようです。
また現時点ではGitHub Agentic Workflowsでは下記のコーディングエージェントが利用できるようです。
| コーディングエージェント | 必要な認証情報 |
|---|---|
| GitHub Copilot | COPILOT_GITHUB_TOKEN |
| Claude | ANTHROPIC_API_KEY |
| CodeX | OPENAI_API_KEY |
| Gemini | GEMINI_API_KEY |
やってみた
環境情報
macOS 26.2
gh version 2.87.3
gh aw version v0.57.2
トークンの作成
今回はGitHub Copilotを利用するのでアクセストークン(PAT)を生成していきます。
Copilot 認証用トークン
以下はGitHub Agentic Workflows上でGitHub Copilotを動かすために使用します。
トークンにはCopilot RequetへRead権限が必要です。
PR / Issue 作成用トークン
別途PRを作ったり、issueを作成するためのPATも別途作っておきます。
作成が完了したら2つのトークンをコピーしておきます。
GitHub Agentic Workflowsをリポジトリに追加する
GitHub Agentic Workflowsの拡張機能をインストールします。
% gh extension install github/gh-aw
今回はDaily Documentation Updaterという公式が提供するドキュメントを自動更新するためのテンプレートを使ってみます。下記コマンドでテンプレートワークフローをローカルリポジトリに追加できます。
% gh aw add-wizard https://github.com/github/gh-aw/blob/v0.45.5/.github/workflows/daily-doc-updater.md
上記コマンドを実行すると
使用するコーディングエージェントを選択する必要があります。今回はGitHub Copilotを選択しました。
┃ Which coding agent would you like to use?
┃ This determines which coding agent processes your workflows
┃ Claude - Anthropic Claude Code coding agent [no secret] [specified in workflow]
┃ > GitHub Copilot - GitHub Copilot CLI with agent support [no secret]
┃ Codex - OpenAI Codex/GPT engine [no secret]
選択後、トークンを聞かれるので、先ほど生成したCopilot 認証用トークンを貼り付けてください。
If you run into trouble see https://github.github.com/gh-aw/reference/auth/#copilot_github_token.
┃ After creating, please paste your fine-grained Copilot PAT:
┃ Must start with 'github_pat_'. Classic PATs (ghp_...) are not supported.
┃ >
次にDaily Documentation Updaterの実行間隔を聞かれます。
今回はお試しなので毎日実行にしておきます。
ℹ This workflow runs on a schedule.
┃ How often should this workflow run?
┃ Current schedule: daily
┃ > Daily - runs once per day (current)
┃ Hourly - runs every hour
┃ Every 3 hours
┃ Weekly - runs once per week
┃ Monthly - runs on the 1st of each month
このワークフローでPRを作っていいか聞かれるのでYesにしておきます。
┃ Do you want to proceed with these changes?
┃ A pull request will be created with the workflow files
┃
┃ Yes, create pull request No, cancel
←/→ toggle • enter submit • y Yes, create pull request • n No, cancel
ここまで実行すると
Github上にPRが作成されていると思います。
これはテンプレートワークフロー(Daily Documentation Updater)関係のファイルを追加するためのものです。
PRの差分を見てみると
ワークフロートリガーのタイミングや自然言語での指示が書かれた.github/workflows/daily-doc-updater.md
そしてワークフローの実態となる.github/workflows/daily-doc-updater.lock.ymlが作成されているのがわかります。
続けて、GitHub Agentic WorkflowsがPRをマージしていいか聞いてくるので、マージします。
┃ What would you like to do with pull request
┃ > Attempt to merge
┃ I'll review/merge myself
┃ Exit
ワークフローを今実行するか聞かれるので、一旦Noにしておきます。
┃ Would you like to run the workflow once now?
┃ This will trigger the workflow immediately
┃
┃ Yes, run once now No, I'll run later
最後に先ほど生成したPR / Issue 作成用トークンを登録しておきます。
% gh aw secrets set GH_AW_GITHUB_TOKEN --value "<PR / Issue 作成用トークン>"
ここまででGitHub Agentic Workflowsをリポジトリに追加し、動作する状態になっているはずです。
サンプルの準備
ドキュメントの自動更新機能を試すために、適当なソースとドキュメントを追加します。
テキストボックスだけのhtmlです。
index.html
<!DOCTYPE html>
<html>
<body>
<input maxlength="64">
</body>
</html>
適当な.md形式のドキュメントも用意しておきます。
Daily Documentation Updaterテンプレートでは/docs/src/content/docs/というディレクトリに置いておくとドキュメントとして読み込んでくれそうでした。
/docs/src/content/docs/トップページ.md
# トップページ 画面設計書
## 概要
| 項目 | 内容 |
|------|------|
| ファイル | index.html |
| 目的 | テキスト入力 |
## 構成要素
| 要素 | 種別 | 属性 |
|------|------|------|
| テキストボックス | `<input>` | maxlength="64" |
## 制約
- 入力上限: 64文字
上記をコミットした後
コードだけテキストボックスの最大文字数を更新し(ドキュメント更新し忘れた想定)
PRを作成・マージしてみます。
マージしたらDaily Documentation Updaterワークフローを動かしてみます
ワークフローが完了するとGithub Copilotがコードとドキュメントの差分を自動で検出し、修正PRまで作成してくれました。
すごい！
最後に
今回はGitHub Agentic Workflowsを使ってドキュメントの自動更新を試してみました。
導入コストも小さく、運用時のガードレール的な使い方も出来そうだなと感じました！
GitHub Agentic Workflowsには他にも色々なテンプレートがあるので活用していきたいですね！
