GitHub Projectのカンバンでカードのアサインを自動で変えるGitHub Actionをつくった

いつものごとくタイトルが長い。

3行

  • GitHubのカンバンで
  • カードを作ったり移動したりすると
  • 自動でカラムごとにアサインを変える

というGitHub Actionをつくった。

GitHub Actions Auto-Card-Assign

github.com

これをつくった。

すでにマーケットプレイスに公開しているのでたぶん誰でも使える。

Auto card assign · Actions · GitHub Marketplace · GitHub

様子

アサインメンバー(Assignee)のアイコンを注視してもらうとよくわかると思う。

カードを移動させると裏でGitHub Actionsが走っていて、カラムごとに設定しておいたメンバーに自動でアサインが変わるようになっている。

つかいかた

リポジトリのREADMEちゃんと書いた(つもり)なので読んで設定すればOKなはず。

GitHub ActionsのJobとかの設定と、当該アクション(Auto-Card-Assign)固有のアサインconfigを用意する必要がある。

configはプロジェクト名+カラム名+カラムごとにアサインしたいメンバーを書くという具合。

kanban1: # Project name
  To do: # Column name
    - "memberName1" # Login name(assignee name)
  In progress:
    - "memberName2"
  Review in progress:
    - "memberName3"
  Reviewer approved:
    - "memberName1"
    - "memberName2"
    - "memberName3"
  Done: []

こういう感じ

『このカラムに動かしたらアサインを全部外したい』という場合は空配列[]にする。

カードを移動してもなにもしたくないカラムの場合は設定に書かなければOK。移動先カラムがconfigに設定されてなければ処理はスキップされるようになっている。

よもやま話

そもそもなんで作ったかというとこのActionsのニーズがあった+GitHub Actions触ってなんかやらないとなんもわからんなってことでちょうど題材があったこいつをつくった。

カンバン運用していてカードを別カラムへ移動させたらアサインを変えたいケースがあって、毎回移動させてからIssueやPRを開いて手でちまちまアサインを変えていてつらかったのでなんとかしたかった。探してもなぜか意外とありそうでなかったのでつくった。なかったということはそもそも世間では需要がないということなのかもしれない。

稼働コストとしてはv1ではだいたい1カードあたり平均15秒くらいで終わる。1分間で4カードさばける計算。GitHub Actionsはフリープランでは2000min/1monthだから、めちゃくちゃ単純に考えると8000回/月は発火できる計算になる。よほど活発でなければ1ヶ月にそんなには発火しないだろうからまあ大丈夫だろうと思っている。

実装のはなしをすると、GitHub API叩くところはv3のRESTじゃなくv4のGraphQLを使っている。ちょうどやりたいことを実現するためのAPIがv4のほうにいい感じに生えてたというのもある。ただ、実装はじめてから気づいたけど、サーバーサイドでGraphQL叩くとTSの型が推論できなくて無理やりオレオレ型書いて解決するしかなかった。クライアントサイドならApolloに乗っかればいいのだけど、サーバーサイドNode.jsだとなんかいい感じのライブラリがなくて諦めた。そもそもサーバーサイドからGraphQLのAPIを叩くんじゃあないよという話かもしれない。

Contribution is always welcome

めちゃくちゃふつうにバグあると思う。

もし発見したらコントリビューションは常に歓迎しています。