Ruby on RailsのソースコードをVSCodeからGit管理する

どうも、tatsuです!

今回は、Ruby on Railsを使って開発したソースコードをVSCodeからGit管理する方法について解説していきます。

本記事はGitについてある程度(コミット、プッシュ、プルなど)理解している方が対象です。

Gitとは
あまりGitについて理解できていない方は以下の書籍が参考になるかと思います。
学習コストが高いと言われているGitを、マンガを用いてわかりやすく解説している書籍です。
※私もこの書籍を読んでGitを学びました。

VSCodeからGit管理する

今回はRailsアプリを作成するところから説明していこうと思います。

まず、以下のコマンドを実行してRailsアプリを作成してください。

rails new git_test_app

次に、VSCodeを起動してください。

起動できたら「フォルダーを開く」をクリックして

対象フォルダを開きます。

実は、Railsで作成されたアプリは最初からGit管理されているため、このままコミットなどを始めることができます。

以下の赤枠部分に「78」という数字が表示されていますよね?
これ、ステージングされていないファイルの数を表しています。

それでは赤枠部分をクリックしてください。

すると以下のような画面になります。

Git管理から除外したいファイル
さて、これらを全てステージングしてコミットしたいのですが、その前に.gitignoreファイルを編集しておきましょう。

.gitignoreに以下の記述を加えてください。

/config/database.yml

※詳しくは、本記事の「Git管理から除外したほうがよいファイル」で解説しています。

ここまでできたら、赤枠部分をクリックしてステージングします。

すると、以下のようにステージングされた状態になるので、

赤枠部分をクリックして

コミットメッセージを入力してEnterを押せばコミット完了です!

 
このように、VSCodeを使えばデフォルトで簡単にGit操作を行うことができるので覚えておきましょう!

また、VSCodeの拡張機能にはよりGit管理を行いやすくしてくれるものもあるので、調べてみるのもいいでしょう。

GitHubと連携する

ローカルでのGitリポジトリをGitHubと連携したい場合、以下のように進めてください。

GitHubとは
GitHubについてあまり理解していない方は以下の記事が参考になるかと思います。

GitHubとは?何のために使うの?使い道を紹介!

2018.07.07

GitHubの登録やリポジトリ作成については、以下の記事を参考にしてください。
※今回やることは、以下記事のSourceTree部分がVSCodeに変わったようなイメージです。

GitHubとSourceTreeを使って簡単にGitの開発手順を説明するよ!

2018.08.30

それではさきほどのフォルダを開いているVSCodeで、上記メニューの「ターミナル」から「新しいターミナル」をクリックしてください。

すると、以下のようにコマンドを実行できるようになります。

ここで、以下のコマンドを実行してください。

git remote add origin https://github.com/リポジトリのパス/リポジトリ名.git
git push -u origin master

実行し終わったら、GitHubのリポジトリにローカルのファイルがプッシュされていることを確認してください。

初回だけコマンドを直打ちする必要がありますが、2回目以降は以下のようにプッシュをすることができます。

Git管理から除外したほうがよいファイル

Git管理から除外したいファイルは.gitignoreファイルに記述します。
.gitignoreファイルの中身はこんな感じです。

# See https://help.github.com/articles/ignoring-files for more about ignoring files.
#
# If you find yourself ignoring temporary files generated by your text editor
# or operating system, you probably want to add a global ignore instead:
#   git config --global core.excludesfile '~/.gitignore_global'

# Ignore bundler config.
/.bundle

# Ignore all logfiles and tempfiles.
/log/*
/tmp/*
!/log/.keep
!/tmp/.keep

# Ignore uploaded files in development
/storage/*
!/storage/.keep

/node_modules
/yarn-error.log

/public/assets
.byebug_history

# Ignore master key for decrypting credentials and more.
/config/master.key

# database.ymlを追加
/config/database.yml

.gitignoreファイルはRailsで「new アプリ」を実行した際に作られますが、Railsのバージョンが上がる毎に中身もアップデートされています。

なので「ruby on rails git 除外ファイル」などで検索すると、Gitで管理すべきでないファイルを説明した記事が多数出てきますが、そのほとんどが最新バージョンのRailsではありません。

最新バージョンのRailsで作られたデフォルトの.gitignoreファイルでは、個人的にdatabase.ymlだけ追加しておけば問題ないという認識です。
※database.ymlにはデータベースのパスワード等が含まれるため。

その他は、Git管理して開発していくうちに.gitignoreファイルに書き足していけば問題ありません。

参考までに、有名な.gitignoreファイルの例を紹介しておきます。
https://github.com/github/gitignore/blob/master/Rails.gitignore

まとめ:Gitを覚えよう!

Railsで作成したアプリがデフォルトでGit管理されていることからもわかるとおり、Ruby on Railsを使って開発するならばGitは必須スキルになります。

複数人で開発しないにしても、Git管理することで昔のファイルをすぐに復元できたり、GitHubと連携してサービスを作っておけばアピールポイントにもなります。

確かに学習コストは高めですが、とても役に立つものなのでぜひ使えるようになっておきましょう!

それでは!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です