みなさんこんにちは！ねこがくれです。
皆さんはドキュメントを書いていますか？
私は書いていません。
めんどくさいからです。
書いたほうがいいというのはわかっています。
ですがやはり、めんどくせぇ！！！誰が書くんだこんなもん！！！ と思ってしまいます。
そこで、GithubActionsでドキュメントを自動生成させてみたので、その備忘録です。
備忘録なので、簡潔に書きます。
ワークフローは以下のとおりです。
今回使ったツールは、GitHub ActionsとCopilot Agentsです。
リポジトリにある.github/agents/docs-agent.md に「何をどうまとめるか」だけを書いておくと、あとは Actionsが勝手に実行してくれます。
一応docs-agents.mdの私が使っているやつを載せておきます。
コードを更新してpushすると、Actionsが起動してCopilotに指示を投げてくれます。
すると、APIの説明や補足情報などを自動で書いてくれます。
そして差分があれば、そのままコミットまでしてくれます。
つまるところ、自分はコードを書くことだけに集中していればよくて気がついたらドキュメントが整っている、という状態になります。いや〜神。
導入自体はそこまで難しくないので、面倒くささに悩んでいる人は一度試してみると楽になります。
GoogleのCodeWikiに着想を得ました。
（もしかしたらこのワークフローは動かないかもしれません。なぜなら、長いこと動かしているわけでもなく、本当に今思いついたからです。いきなり本番環境では動かさずに、個人の責任で動かしてください）