teccon forum

Gitサーバー構築

7 min read

Gitサーバーのセットアップ

Gitサーバーは、ソフトウェア開発チームのコラボレーションとコード管理に不可欠です。本書では、Gitサーバーのセットアップから運用まで、具体的な手順とともに解説します。特に、Giteaを使った自前のGitサーバー構築を中心に、SSHキーの設定やWebhookの利用、プルリクエストとブランチフローの活用まで、実践的な知識を体系的に学びます。

Gitサーバーの概要

Gitサーバーを運用することで、複数の開発者が同時にプロジェクトに参加し、コードのバージョン管理や共同作業を効率化できます。主な機能は以下の通りです。

  • リポジトリの管理: 開発者が自分の作業をリモートリポジトリに保存し、他のメンバーと同期することができる。
  • ブランチ運用: 複数の開発者が異なる機能を独立して開発し、必要に応じて統合する。
  • プルリクエスト: 開発者同士がコードをレビューし、マージする前に品質チェックを行う。
  • SSHキーの認証: 安全かつ便利な認証方法でリポジトリにアクセスする。

Giteaのインストール

Giteaは、軽量で柔軟性の高いGitサーバーソフトウェアです。GitHubやGitLabのような多くの機能を備えており、セルフホスティング可能なため、中小規模の開発チームに最適です。

システム要件

  • OS: Linux、macOS、Windows（本書ではLinuxを例に説明）
  • 必要なツール: Git、SQLite（もしくはMySQL/PostgreSQL）、SSH

Giteaのインストール手順

  1. 依存関係のインストール まず、必要なパッケージをインストールします。

    sudo apt update
sudo apt install -y git sqlite3

  2. Giteaのダウンロードとインストール Giteaの公式サイトから最新バージョンを取得し、サーバー上にインストールします。

    wget -O gitea https://dl.gitea.io/gitea/1.17.0/gitea-1.17.0-linux-amd64
chmod +x gitea
sudo mv gitea /usr/local/bin/

  3. Giteaの初期設定 Giteaを起動し、ブラウザで設定を行います。

    sudo ./gitea web

    ローカルホストのhttp://localhost:3000にアクセスし、データベース設定やリポジトリのディレクトリを指定します。デフォルトでは、SQLiteを使用する設定が最も簡単です。

SSHキーの設定

Gitサーバーにアクセスするための安全な方法として、SSHキーを使用します。開発者は自分のマシンで生成したSSH公開鍵をサーバーに登録することで、パスワードなしで安全に接続できます。

SSHキーの生成

クライアントマシンで以下のコマンドを実行し、SSHキーを生成します。

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
  • id_rsa.pubというファイルに公開鍵が保存されます。この公開鍵をGiteaの管理画面に追加します。

Giteaに公開鍵を登録

Giteaのウェブインターフェースでユーザー設定に移動し、「SSH Keys」メニューから公開鍵を登録します。登録が完了すると、そのユーザーはSSH経由でリポジトリにアクセスできるようになります。

Webhookの設定

Webhookは、リポジトリの更新やプルリクエストが発生したときに外部サービスへ通知を送信するための仕組みです。これにより、CI/CDパイプラインの自動実行や通知システムとの連携が容易になります。

Webhookの追加手順

  1. Giteaのリポジトリ設定に移動します。
  2. 「Webhook」タブから新しいWebhookを追加します。
  3. 送信先のURLとトリガー条件を設定します。

例えば、プッシュ操作ごとにCI/CDシステムをトリガーするように設定することができます。

ブランチとプルリクエストの運用

ブランチフローは、開発チームの作業を整理し、個々の機能開発やバグ修正を並行して進めるための基本手法です。各開発者は、独自のブランチで作業を進め、最終的にプルリクエストを使って他のメンバーにレビューを依頼します。

ブランチの作成

新しい機能を開発する際は、メインブランチから分岐させた新しいブランチを作成します。

git checkout -b feature/new-feature

ブランチを切り替えることで、既存のコードに影響を与えずに安全に作業を進めることができます。

プルリクエストの作成

ブランチでの作業が完了したら、Giteaのウェブインターフェースからプルリクエストを作成します。他の開発者はこれを確認し、コードレビューを行った後、承認されればメインブランチにマージされます。

コラボレーションの促進

Gitサーバーは、開発チーム内でのコラボレーションを円滑に進めるための中心的な役割を果たします。ブランチ運用、プルリクエスト、コードレビューなどの機能は、チームの品質を保ちながら効率的に作業を進めるために必要不可欠です。

プロジェクト管理のベストプラクティス

  • ブランチの命名規則を定める: 開発内容に基づいた命名規則を設定し、ブランチ管理を分かりやすくする。
  • 定期的なレビューを行う: 定期的にプルリクエストを確認し、品質を保ちながら作業を進める。
  • CI/CDの自動化を活用する: Webhookを使って、テストやデプロイを自動化し、リリースサイクルを短縮する。

まとめ

本書では、Giteaを使ったGitサーバーのセットアップから、SSHキーの設定、Webhookによる自動化、ブランチフローとプルリクエストの運用までを解説しました。これらのツールと手法を活用することで、開発チームは効率的かつ安全に作業を進めることが可能になります。

Graph View