🌟 はじめに
おぐまです。
Zennの記事をGithubで管理・運用しています。
現状Githubの対象リポジトリには master/main ブランチしかない & 特に記事ファイルの中身のチェックもしていません。
今回はブランチという名前の通り master/main だけでなく枝分かれさせてGithubをちゃんと運用するためのTipsです🌜
👷♂️ 事前準備
💻 開発環境
- macOS Sonoma 14.3
- Visual Studio Code 1.85.2 (Universal)
- Git 2.39.3
👉 ちゃんとしたブランチ構築
そもそもmaster/mainブランチだけの運用はダメなのか
正直言って個人プロジェクトであれば特に問題ないです多分
ですがエンジニアとして働いている人、働くよって人だったらマナーとしてこのくらいやった方がいいんじゃないのかしら😷という思いも込めて👇
-
リスク管理
master/mainブランチだけで運用すると、未完成の変更が誤って本番環境に適用されるリスクが高まります😨
複数のブランチを使用することで開発中の変更と完成した変更を分けられるので安全性を高めることができます。 -
柔軟性の向上
複数のブランチを使うことで異なる機能や記事など並行して開発しやすくなります。
ブランチの使い方と運用
今回作成するブランチと運用方法を考えました。
-
masterブランチ
公開準備が整った完成品のみを保持
developやfeatureブランチからの変更をマージする用。 -
developブランチ
開発や更新作業の場所
ここでの変更は定期的にレビューし問題なかったらしたらmaster/mainブランチにマージする用。 -
featureブランチ
特定の記事や大きな更新の時に作成 ※多分ほぼ使わない
作業完了したらdevelopブランチにマージし、さらにレビューとテストを経てmaster/mainブランチへと進む想定。
ブランチ作成の手順
ターミナルを開いて対象のローカルリポジトリ配下でコマンド実行するだけ！簡単🕺
-
開発ブランチの作成
developブランチを作成します。
このブランチは新しい記事の執筆や既存記事の更新に使用します。
git checkout -b develop
-
フィーチャーブランチの作成
以下コマンドで個別の記事に対するブランチを作成します。
記事ごとにブランチを分けるので、特定の内容に集中できる。
git checkout -b feature/記事名
🎉 まとめ
Zennの記事管理で主にGit運用(ブランチ編)について説明しました。
次はGithub ActionsでMarkdown Linterの導入して記事の品質を高めつつ管理プロセスを楽したいと思います！
💡 参考
Discussion