koudenpaのブログ

趣味のブログです。株式会社はてなでWebアプリケーションエンジニアをやっています。職業柄IT関連の記事が多いと思います。

GitHub Pagesのカスタムドメイン設定がデプロイのたびに消えていた話

GitHub Pagesのカスタムドメインをブラウザ上(リポジトリ > Settings > Pages)でなんとなーく設定していたところ、記事名の通りデプロイのたびにカスタムドメインの設定が消えて github.io に戻ってしまって「なんでやねん?」となっていた。

なんでかは当然ドキュメントに書いてある。

GitHub Pages サイトのカスタムドメインを管理する - GitHub Docs

[カスタム ドメイン] で、カスタム ドメイン名を入力してから、 [保存] をクリックします。 ブランチからサイトを公開している場合は、ソース ブランチのルートに CNAME ファイルを追加するコミットが作成されます。 カスタムの GitHub Actions ワークフローを使用してサイトを公開している場合、CNAME ファイルは作成されません。 公開元の詳細については、「GitHub Pages サイトの公開元を設定する」を参照してください。

GitHub Pagesに特定のブランチをデプロイしている場合、そのブランチのルートにあるCNAMEというファイルの内容がカスタムドメインとして認識されるようだ。

自分のケースでは、GitHub Actionsでのデプロイ対象ファイルのビルド結果をそのブランチにPushしていたので、GUIで設定、作成されたCNAMEファイルがデプロイのたびに消えていたようだった。

デプロイ対象にCNAMEファイルを追加したらカスタムドメイン設定が維持された。

github.com


このカスタムドメインがいつの間にか空白に戻っていて「???」状態だった。