メインコンテンツへスキップ
見出し画像

コピペされた CI をやめて、共通化する話

    はじめに

    リポジトリを横断して仕事をしていると、必ず同じものに出くわします。それは「ほとんど同じ内容の CI ワークフロー」です。lint して、テストして、ビルドする——やることは同じなのに、リポジトリの数だけ YAML が複製されている。

    今回は、この「コピペされた CI」を GitHub Actions の reusable workflow(再利用可能ワークフロー)でまとめた話を、技術の細部よりも考え方に寄せて書きます。

    背景

    CI の設定は、最初はたいてい1つのリポジトリで始まります。うまく動いたので、次のリポジトリにコピペする。また次にコピペする。悪意はまったくなく、そのときはそれが一番速い。

    問題が表に出るのは、少し先です。

    起きていた課題

    ある日、「使う言語ランタイムのバージョンを上げたい」という話になります。やること自体は一行の変更です。ところが、同じ一行がリポジトリの数だけ散らばっている。結果、同じ変更を何度も繰り返すことになります。

    もっと厄介なのは、コピペ元がいつの間にかズレていくことです。片方にはキャッシュ設定があって、もう片方には無い。誰かが片方だけ直して、もう片方を忘れる。「同じはずのもの」が少しずつ違ってしまい、その違いが事故の温床になります。

    検討したこと

    「共通化したい」と思ったとき、GitHub Actions には道が2つあります。

    ひとつは、手順の束(セットアップ一式など)を小さな部品にする方法。もうひとつは、ワークフローを丸ごと共有する方法です。今回は「CI の工程ぜんぶを共有したい」ので、後者——reusable workflow を選びました。

    ここで意識したのは、何を固定して、何を変えられるようにするかの線引きです。全部を固定すると柔軟性が失われ、全部を可変にすると共通化の意味が薄れる。「ランタイムのバージョン」や「ビルドを実行するかどうか」だけを外から渡せるようにして、残りは共有側に閉じ込めました。

    実際に行った対応

    やったことはシンプルです。共通の CI を1箇所に置き、各リポジトリのワークフローは「それを呼び出すだけ」にしました。呼び出し側は数十行から数行になりました。

    地味だけれど効いたのが、参照をバージョンで固定したことです。「最新を自動で参照する」設定にすると一見便利ですが、共有側を直した瞬間に全リポジトリへ即座に波及します。良い変更ならいいのですが、壊れていたら全リポジトリが同時に壊れる。だから「タグで固定して、更新は意図的に切り替える」形にしました。便利さより、変更が波及するタイミングを自分で握れることを優先した判断です。

    得られた学び

    ひとつは、共通化は「技術」より「どこに境界を引くか」の問題だということ。可変にすべき点と固定すべき点を見極められれば、仕組み自体は難しくありません。

    もうひとつは、自動更新は諸刃の剣だということ。全リポジトリに一括で反映できる仕組みは、便利さと危うさが裏表です。「いつ波及するかを人間が決められる」余地を残しておくと、安心して共通化に踏み切れます。

    コピペは、その場では一番速い。でも「同じものを3回コピペした」と気づいたら、それは共通化の合図です。少し立ち止まって1箇所にまとめると、半年後の自分がずいぶん楽になります。

    まとめ

    • コピペされた CI は、変更の波及と「じわじわズレる」事故を生む

    • 共通化では「何を可変にして何を固定するか」の線引きが本質

    • 一括反映の仕組みほど、波及タイミングを人間が握れるようにしておく

    あなたへのおすすめ