技術情報

GitHubでプライベートリポジトリを作成する方法

今回はGitHub上にプライベートリポジトリを作成する方法を記載しておきます。

こちらは社内新人向けメンバー用に、まずGitHubでプライベートリポジトリを作成し、そこでコード管理・VS Code連携・Push/Commitに慣れてもらう環境を作成する為のドキュメントとなっています。

GitHubへの登録

アカウント作成・サインイン

まず、GitHubのアカウントを作成する為に、公式サイトにアクセスします。

こちらにメールアドレスを入力して、[Sign up for GitHub]を押します。

以下の画面が出てくるので、メールアドレス・パスワード・ユーザー名・国を入力します。
そして、メールで情報を取得したい場合はチェックを付けて[Continue]を押します。

画面の指示に従って、ロボットでないことを証明します。

noreply@github.comより登録したメールアドレス宛にメールが届くので、コードを入力します。

サインイン画面が開きます。
登録したアカウント情報を入力して、サインインしてください。

無事にサインインすると、ダッシュボード画面が開きます。
ちなみに右上のプロフィールのアイコンは、Gravatarから自動取得されますね(Slackとかと同じです)

プライベートリポジトリを作成する

次に、プライベートリポジトリを作成します。

サインイン後に出てくるダッシュボード画面で、左の[Create repository]を押します。

ポイント

既にリポジトリを登録していた場合、リポジトリの検索画面になりますので、この場合は[New]ボタンを押してください。

Create a new repository画面が開きます。

  • Repository name
    リポジトリの名前を付けます。
  • Description
    リポジトリの説明を入れます。(ここは日本語OKです!)
  • 今回は公開するコードにしないので[Private]を選択します!

Initialize this repository with:

  • Add a README file …
    チェックしておくと、リポジトリ画面に表示されるドキュメントREADME.mdファイルを自動生成してくれますのでチェック推奨。
  • Add .gitignore: …
    どの言語環境向けに.gitignoreファイルを自動生成するか選択できます。
    (Laravelとかを使うならLaravelを選択しておくといいです)
  • Choose a license: …
    どのライセンス形態でソースコードを配布するかを選択します。選択に応じてライセンス文面を表したLICENSEファイルを自動生成されます。プライベートなんでnoneでいいかと。

最後に[Create repository]を押すと、これでプライベートリポジトリを作成できるはずです。
(ダッシュボードに、作成したリポジトリが表示されていれば成功です!)

GitHubへのプッシュ方法

Gitをダウンロード・インストール

リポジトリの初期化

プロジェクトフォルダを開いてコマンド実行。

git init

以下のように Git リポジトリが作成されるはずです。(.gitフォルダ)

Initialized empty Git repository in <プロジェクトフォルダ>/.git/

ブランチ名を変更

とりあえずブランチ名をmainにします

git branch -m main

.gitignore を確認

.gitignore の内容を確認しておきましょう。

.gitignore は、要はアップするのを除外するファイルです。
Laravelだったら .env といったファイルにAPIキーやDBパスワードを定義されているかと思いますが、それらを .gitignore に入れて除外します。
(普通だったら、ファイルができていて、 .env ファイルは既に登録されて除外されているはずです)

ステージング・コミット

ファイルをステージングして、コミットを実行します。

git add .
git commit -m "初回コミット"

ポイント

初回の場合、以下のようなメッセージが表示されます。

これは、Git のユーザー情報(名前とメールアドレス)を設定してくださいという事ですね

Author identity unknown

*** Please tell me who you are.

Run

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

以下のコマンドでGitHubのユーザー名とメールアドレスを設定します。

git config --global user.name "ユーザー名"
git config --global user.email "メールアドレス"

登録されたか確認したい場合は、以下のコマンドで

git config --list

設定されていれば、以下のように出るはずです

user.name=ユーザー名
user.email=メールアドレス

GitHubのPersonal Access Token(PAT)を取得する

GitHubでは2021年以降、パスワードでのHTTPSログインが廃止された為、アクセスするのに必要なトークン(Personal Access Token)を取得します。

まず、以下のサイトにアクセスします

Fine-grained tokens ではなく Tokens (classic) を選びます(※今はClassicでOK)

[Generate new token]を押します。

[Generate new token (classic)] を選択します。

Note:
名前を自由に決めます

有効期限:30日になっているので、もっと長期に90日 or 無期限も選択できます

スコープ(権限)は必要なものにチェックを入れます。

最後に[Generate token] をクリックしてトークンを生成します。

表示されたトークン(英数字の長い文字列)をコピーしておきましょう(あとで表示できません!)

このトークンが、あとでプッシュする際のパスワードになります。

GitHub に接続してプッシュ

以下のコマンドを実行
※GitHubの初期データをローカルに取り込んでから pushしています(2行目)

git remote add origin <GitHubのリポジトリのアドレス>
git pull --rebase origin main
git push -u origin main

これでブラウザでリポジトリを見ると、無事にコードが登録されたかと思います。

また、VS Codeで今回のプロジェクトを開いたときに左サイドバーのソース管理が利用できるようになるかと思います。

ポイント

ちなみにパスワードはキャッシュしておくと便利です。

git config --global credential.helper cache

永続化しておきたい場合はこちら。

git config --global credential.helper store

以上のように、今回はGitHubにアカウントを作成して、プライベートリポジトリを作成する方法を紹介しました。

GitHubは、少人数のチームで厳密な開発ルールとかが無い環境であれば、無料枠で十分な機能がありますね。

また、我々の会社のように、リモートで別々の場所で開発していると特に、ローカルの環境のバックアップは個人の裁量に依存してしまうので、大切な資産であるコードをGitHubを使っていればクラウドにバックアップできるという意味でも、非常に価値があるかと思っております。

株式会社OZでは、他の方達にも有益と思われる情報は、社内ナレッジに留めず、積極的に情報公開するという方針をとっております。
株式会社OZをよろしくお願いします!

-技術情報
-