Zenn
👌

GitHubでリポジトリを作成。とローカルにクローン。

2021/11/22に公開
GitHub
tech

概要

ようわからんけどひとまずやってみようという温度感のGitHubリポジトリ作成方法です。

リポジトリ作成

何はともあれリポジトリを作成します。GitHubのサイト上でできます。

手順

  1. GitHubのページ右上の「＋」をクリックし、「New repository」。

  2. リポジトリの名前をつける。日本語も入力できちゃうけど、実際は英数でしか作られないっぽいので英数で入力する。短くして、スペースは使わずにハイフンでつなぐのがいい感じ。

  3. その下のDescriptionは任意入力。説明を記入しておきましょう。自分は空気を読まずに日本語で書きます。

  4. 公開設定はとりあえずPrivateに。

  5. リポジトリの初期設定を選びます。Add a README fileくらいはチェックしておいて良いと思います。

    • Add a README file
      リポジトリのルートにREADME.mdファイルを作成します。このREADME.md内に記述した内容が、そのリポジトリのトップ画面で説明として表示されます。
    • Add .gitignore
      チェックイン時にどのファイルを無視するかという、.gitignoreファイルを作ります。細かい説明は巻末の.gitignoreについてを参照
    • Choose a license
      このリポジトリがどんなライセンスかを明確に表すときにチェックします。GPLライセンスとかMITライセンスとか

  6. Create repository

  7. リポジトリが作られました。README.mdだけがあるリポジトリです。
    でトップにREADME.mdの内容が表示されてます。


ローカルにクローン

ついでなので、作ったリポジトリをローカルにクローンするのも試してみます。
手元のパソコンにGitクライアントがインストールされていることが前提です。↓
https://zenn.dev/ctrlkeykoyubi/articles/5f70cd26c25c21

手順

  1. ローカルにクローン先のフォルダを作っておきます。名前はとりあえず「Git」で、どこでも良いです。自分はドキュメントの下に作りました。

  2. GitHub上で作ったリポジトリのページを開きます。そこの「Code」をクリックし、表示された「HTTPS SSH GitHub CLI」のコピーボタンをクリックします。クリップボードにURLがコピーされます。

  3. 最初に作ったローカルのGitフォルダを右クリックし、「Git Bash Here」をクリックする。
    ※右クリックのメニューにこのコマンド追加してない人はごめん、普通にGit Bash起動してフォルダ移動してください。

  4. Gitフォルダをカレントディレクトリにした状態でGit Bashが起動する。いいかい、そこでこう入力するんだ。(耳元で悪魔の一言をつぶやくように)
    Git Clone さっきコピーしたリポジトリのURL

  5. おっと、GitHubのサインイン画面が出てきた。そりゃそうだ、これはプライベートリポジトリだから、誰でもクローンできるわけじゃあない。認証が必要ってわけだ。「Sign in with your browser」。

  6. ブラウザでGitHubへのサインイン画面が開かれる。さあサインインしてくれ。

  7. GitHubが…俺に語りかけてくる…権限をよこせ…さすれば力を授けよう…と───。Authorize。

  8. うまくいきました。ブラウザは閉じていいです。

  9. さっき開いてたGit Bashを確認すると、いつの間にか進んでます。うまいことdoneしたらしいです。Git Bashは閉じていいです。

  10. ローカルのGitフォルダを確認してみます。なんということでしょう…何もなかった更地に、職人がリポジトリのクローンフォルダを作ってくれています…。

.gitignoreについて

リポジトリのルートディレクトリに.gitignoreファイルを置くことで、.gitignoreファイル内で指定したファイルをチェックインしないようにできるそうです。
例えば「zipファイルとかpdfファイルはリポジトリに入れる必要ないよね」みたいな感じ。

もうちょい説明

.gitignoreファイルの入手

いろんな用途に適した.gitignoreファイルがGitHubから提供されています。
https://github.com/github/gitignore

この中で例えばJavaようの.gitignoreファイルはこんな感じ。classファイルだとか圧縮系ファイルはチェックインしないように設定されている。

# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*



あと、目的に応じた.gitignoreファイルを生成してくれるgitignore.ioというサービスもあります。
https://www.toptal.com/developers/gitignore

例えばJavaと入力して、それ用の.gitignore設定が存在すると候補が出てくるので、それを選択して作成する。

するとその内容が表示される。

公式ヘルプ

公式ヘルプは下記。細かいことを確認したいときは参照してください。
(日本語ですが機械翻訳的な…)
https://docs.github.com/ja/get-started/getting-started-with-git/ignoring-files

Discussion