非エンジニア向け GitHub リポジトリの作成

programing

リポジトリの作成

実際に公開されるリポジトリを作成します。

右上のツールバーにある

「New repository」というリンクをクリックして、リポジトリを新たに作ります。

Repository name

今回は「Hello-World」と入力します。

Description

リポジトリの説明を設定できます。必須ではありませんから、空白でも大丈夫です。

Public、Private

Public、Privateが選択できるようになっています。今回はPublicを選択してください。公開リポジトリとして作成され、リポジトリの内容は全て公開されます。

Privateを選択するとアクセス制限を設定できる非公開リポジトリを作成できますが、有料となります。

Initialize this repository with:

Add a README file にチェックを入れてください。GitHubのリポジトリの初期化とREADMEファイルの設置を自動的に行ってくれるため、作成直後からこのリポジトリをcloneできるようになります。既に手元にあるGitリポジトリうぃGitHubに登録したい場合はチェックをせずに手動でpushすることをおすすめします。

Add .gitignore

この下にあるプルダウンメニューが便利なので覚えておいてください。これは.gitignoreファイルを初期化時に作成してくれます。この設定をしておけば、一般的にGitリポジトリに含めてバージョン管理しなくてもよいファイルをあらかじめ.gitignoreファイルに記述してくれるので、毎回フレームワークに合わせて設定する作業から解放されます。プルダウンメニューには主要な言語やフレームワークがあるので、利用予定のものを選択してください。今回は特にフレームワークなどは利用しないので、洗濯しません。

入力や選択を完了したら、「Create repository」をクリックしてください。これでリポジトリが完成しました。

Choose a license

このプルダウンでは、追加するライセンスファイルを選択できます。このリポジトリに含めるコードのライセンスを決める場合は選択してください。ライセンスの内容が書かれたLICENCEファイルがリポジトリに作成されます。このリポジトリにふくまれるもののライセンスを表明することになります。

リポジトリにアクセス

次のURLが、今回作成したリポジトリのページです

https://github.com/(ユーザー名)/Hello-World

README.md

既にREADME.mdが初期化時に作成されています。README.mdファイルはリポジトリのトップページに自動的に中身が表示されます。したがって、このリポジトリに入っているソフトウェアの概要、利用するための手順、ライセンスなどが明記されているのが一般的です。Markdown記法で記述すれば、とても読みやすくマークアップしてくれます。

GitHub Flavored Markdown

GitHubでのコミュニケーションで使われるIssueやコメントやWikiは、Markdown記法で記述すればマークアップしてくれます。正確には、「GitHub Flavored Markdown」(GFM)と呼ばれる記法です。Markdownをベースに拡張しているようですが、基本的には従来のMarkdownで書けば問題ありません。

GitHubを利用していると、ドキュメントの多くはMarkdownで書くことになります。つまり、全世界の多くのプログラマーがMarkdownを使うことになるので、プログラマの標準的なスキルの一つと考えざるを得ません。是非Markdown記法を身に付けましょう。

コードを公開

作成したリポリトジをcloneする

作成したリポジトリに、実際にコードを登録して公開してみます。まず、作成したリポジトリのcloneを手元の開発環境に持ってきます。

cloneする際に指定するパスは、上記を参考にしてください。

nakat@DESKTOP-27FOU5L MINGW64 ~
$ git clone git@github.com:nakata1967/Hello-World.git
Cloning into 'Hello-World'...
Enter passphrase for key '/c/Users/nakat/.ssh/id_rsa':(パスフレーズを入力
remote: Enumerating objects: 3, done.
remote: Counting objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Receiving objects: 100% (3/3), done.

ローカルPCにHello-Worldディレクトリが出来ています。

nakat@DESKTOP-27FOU5L MINGW64 ~
$ cd Hello-World

nakat@DESKTOP-27FOU5L MINGW64 ~/Hello-World (main)
$ git status
On branch main
Your branch is up to date with 'origin/main'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        hello_world.php

nothing added to commit but untracked files present (use "git add" to track)

hello_world.phpはまだGitリポジトリに登録されていないので untracked files として表示されます。

コミットする

hello_world.phpをリポジトリにコミットします。これにより、バージョン管理システムの管理下に置かれることになります。今後の変更管理はGitによって保持されます。

nakat@DESKTOP-27FOU5L MINGW64 ~/Hello-World (main)
$ git add hello_world.php

nakat@DESKTOP-27FOU5L MINGW64 ~/Hello-World (main)
$ git commit -m "Add hello world script by php"
[main 51b1cc7] Add hello world script by php
 1 file changed, 3 insertions(+)
 create mode 100644 hello_world.php

git add コマンドでステージ(コミットする前のファイル状態を記録したインデックスというデータ構造に記録することです。)し、git commitコマンドでコミットしています。
無事に追加されたかは、git logコマンドを利用してコミットログを参照して確認できます。

nakat@DESKTOP-27FOU5L MINGW64 ~/Hello-World (main)
$ git log
commit 51b1cc7aa767a506557a333a0c457ff7dce3e332 (HEAD -> main)
Author: Yoshihiko Nakata <メールアドレス>
Date:   Sat Jun 3 15:42:09 2023 +0900

    Add hello world script by php
以下省略

pushする

あとはpushを実施することによって、GitHub側のリポジトリが更新されます。

nakat@DESKTOP-27FOU5L MINGW64 ~/Hello-World (main)
$ git push
Enter passphrase for key '/c/Users/nakat/.ssh/id_rsa':
Enumerating objects: 4, done.
Counting objects: 100% (4/4), done.
Delta compression using up to 12 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 339 bytes | 339.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
To github.com:nakata1967/Hello-World.git
   88c03a2..51b1cc7  main -> main

これでGitHubにコードが公開されました。実際に、
https://github.com/(ユーザー名)/Hello-World
にアクセスして、確認してみます。


コメント

タイトルとURLをコピーしました