GitHub Actionsを使ってテックブログの執筆を省力化する
株式会社enechain / nakker1218
メンバー / フロントエンドエンジニア / 従業員規模: 101名〜300名 / エンジニア組織: 51名〜100名
ツールの利用規模 | ツールの利用開始時期 | 事業形態 |
---|---|---|
51名〜100名 | 2020年2月 | B to B |
ツールの利用規模 | 51名〜100名 |
---|---|
ツールの利用開始時期 | 2020年2月 |
事業形態 | B to B |
アーキテクチャ
導入の背景・解決したかった問題
導入背景
ツール導入前の課題
GitHub Actionsを用いた運用を開始するまで、テックブログを公開するにあたり以下の手順を実施していました。
- Notion上で執筆を行う
- CTO, 上長がNotion上でレビューをおこなう
- Mediumのアクセス権をもらい、入稿を行う
- テックブログ運営チームがFigmaでOGP画像を作成する
- 公開
この運用では3つほど課題がありました。
- 指摘したレビューがどのように修正されたかがわかりにくい
- てにをはの指摘など毎回同じようなレビューが発生し、レビュワーの負担が大きい
- OGPの作成をFigmaの編集権限があるひとに毎回依頼する必要がある
どのような状態を目指していたか
公開前の定型的な作業や公開作業の自動化、記事作成からレビュー・公開までのプロセスを整備し仕組みに落とし込むことで、運営メンバーなしでも執筆・公開ができる状態を目指しました。
導入の成果
GitHub Actionsを使うことで公開にあたって必要な作業の多くが自動化され、定型作業が減り執筆のサポートなどに時間を使うことができるようになりました。 また、記事の管理と公開までの仕組みを同じプラットフォーム上で完結することができるので、管理が楽になりました。
導入前に解決したかった課題は以下のように解決されました。
- 指摘したレビューがどのように修正されたかがわかりにくい
GitHubのPR上でコードレビューを行うため変更が差分として残るようになりました。また、Suggestion changedの機能を使うことで修正してほしい内容を伝えやすく、取り込みやすくなりました。 - てにをはの指摘など毎回同じようなレビューが発生し、レビュワーの負担が大きい
GitHub Actions上でtextlintをかけることで、てにをはの指摘を自動化できました。 - OGPの作成をFigmaの編集権限があるひとに毎回依頼する必要がある
GitHub Actions上でCloudinaryのCLIを実行し、OGP画像を自動生成することで、画像の生成にFigmaの編集権限を持つ人が不要になりました。
執筆プロセスを定義しGitHub Actionsを活用した自動化を導入した結果、執筆体験の向上に繋がり、不定期に月1,2本程度公開していたブログの投稿頻度が毎月3本定期的に公開できるようになりました。
導入時の苦労・悩み
GitHubでの記事管理に対応しているブログツールでないと自動化の観点で選定できなく、選択肢が少なかったのが難しい点でした。
GitHubでの記事管理に対応しているブログツールの例
- はてなブログ
- Zenn
当初enechainのテックブログのポスティングにつかっていたMediumは、GitHubでの管理に対応しておらず、ポスティング先も同時に変える必要がありました。
導入に向けた社内への説明
上長・チームへの説明
GitHub Actionsの導入については、既に社内のほかプロダクトで導入・運用されており大きな障壁なく導入が進みました。また、エンジニアが普段開発に使っているツールなので使い方の説明もスムーズに進みました。
活用方法
よく使う機能
- Workflow dispatch
手動でワークフローを発火させる機能です。
主にブログ記事の作成時に利用しています。詳細はこちらを参考にしてください。 - Composite Action
GitHub Actions上のワークフローを共通化する機能です。
enechainのテックブログでは、はてなブログ上に画像のアップロード仕組みなどを共通化しています。
ツールの良い点
- エンジニアが普段使っているGitHub上で完結するので、導入や説明コストが低い
- GitHub Actionsを使うことで、PRをマージするだけでブログ公開までのフローが完結する
ツールの課題点
ツールとしての課題ではありませんが、エンジニアだけでなくPdMやデザイナーがブログを書く際に、GitHubの使い方を知って貰う必要があるので人によっては執筆コストが上がってしまいました。しかし、マニュアルを丁寧に整備し、https://github.dev/
上で執筆することでコミットやワークフローの実行も今のところスムーズに行えています。
ツールを検討されている方へ
テックブログの運営において、エンジニアが普段使っているツールでプロセスを作成・運用することで、作業の効率化だけでなく執筆体験の向上につなげることもできました。
株式会社enechain / nakker1218
メンバー / フロントエンドエンジニア / 従業員規模: 101名〜300名 / エンジニア組織: 51名〜100名
よく見られているレビュー
株式会社enechain / nakker1218
メンバー / フロントエンドエンジニア / 従業員規模: 101名〜300名 / エンジニア組織: 51名〜100名
レビューしているツール
目次
- アーキテクチャ
- 導入の背景・解決したかった問題
- 活用方法