GitHubのリポジトリ作成についてまとめています。
GitHubのリポジトリの作成
GitHubで新規にリポジトリを作成してみましょう。まずは、GitHubにサインインし、Repositories→Newボタンをクリックします。
関連)GitHub公式ページ
Create a new repositoryという画面が表示されます。
Repository nameにリポジトリ名を入力し、Add a README.fileにチェックをつけ、Create Repositoryをクリックします。
Public/Privateは、作成したリポジトリをGitHubユーザ全体に公開するか(Public)、アクセス権を持つユーザにのみ公開するか(Private)を選びます。
Add a README fileにチェックを入れておくと、README.mdというリポジトリの説明を記述するファイルが作成されます。
リポジトリが新規作成され、以下の画面が表示されます。
今回は空欄のままにしましたが、Create a new repositoryのAdd .gitignoreにチェックをつけると、git管理の対象外ファイルを記述する、.gitignoreファイルを生成することが可能です。チェックをつけると言語が選べるようになります。言語ごとに、デフォルトで対象外とするファイルが異なるんですね。
例えば、PHPを選択すると.gitignoreは以下の内容になります。コンパイル済みのクラスファイル、ログファイル、一時ファイル、パッケージファイルなどがgit管理の対象外になるよう設定がされます。
# 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*
Choose a licenseにチェックをつけると、リポジトリで公開するソフトウェアのライセンスを記述することができます。
例えば、MITライセンスを選ぶと、LICENSEというファイルに以下の内容が生成されます。
MIT License Copyright (c) 2021 ownername Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.gitignoreもLICENSEも、リポジトリを作成してからテンプレート選択することが可能です。リポジトリにてAdd file→Create new fileを選び、ファイル名を.gitignoreまたはLICENSEと入力すると、テンプレート選択用のボタンが出現します。
コマンドラインからリポジトリを作成する
GitHubのCLI(ghコマンド)を利用すると、コマンドラインからリポジトリの作成が可能です。
【関連記事】
▶GitHubのCLI(コマンドラインインタフェース)はghコマンド プルリクエストやissue操作にも対応
gh repo createを実行すると、対話形式でリポジトリが作成されます。Publi/Privateの選択など矢印キーとEnterキーで入力する箇所もあります。以下は、testrepoというリポジトリを作成する例です。
$ gh repo create ? Repository name testrepo ←リポジトリ名を入力 ? Repository description this is test repository ←リポジトリの詳細を入力 ? Visibility Public ← PublicかPrivateを選択 ? This will add an "origin" git remote to your local repository. Continue? Yes ←リモートにリポジトリを作成してよいか? ? Created repository ownername/testrepo on GitHub fatal: remote origin already exists. /usr/bin/git: exit status 128
GitHubにサインインして確認すると、testrepoというリポジトリが作成されていました。
gh repo create実行時に、-lオプションを使用してLICENSE、-gを使用して.gitignoreをテンプレートから生成することが可能です。
ghのオプションは以下の公式ページを参照してください。
関連)gh repo create | GitHub CLI
まとめ
- GitHubのウェブ画面から、リポジトリの新規作成が可能
- LICENSEや.gitignoreなど一部のファイルはテンプレートの利用ができる
- ghコマンドを使うと、コマンドラインからリポジトリの作成が可能