-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrails-git.html
185 lines (176 loc) · 10.7 KB
/
rails-git.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Rails with Git and GitHub · RailsApps</title>
<link href="https://plus.google.com/u/0/b/117374718581973393536/117374718581973393536/posts/" rel="publisher" />
<link rel="stylesheet" href="/css/bootstrap.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/screen.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/gollum.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/site.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/syntax.css" type="text/css" charset="utf-8" />
<script src="http://code.jquery.com/jquery-1.6.min.js" type="text/javascript"></script>
<script src="/javascript/jquery.text_selection-1.0.0.min.js" type="text/javascript"></script>
<script src="/javascript/jquery.previewable_comment_form.js" type="text/javascript"></script>
<script src="/javascript/jquery.tabs.js" type="text/javascript"></script>
<script src="/javascript/gollum.js" type="text/javascript"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-5109366-14']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a href="/" class="brand">RailsApps Project</a>
<ul class="pull-right nav">
<li><a href="http://blog.railsapps.org/" class="twitter">Blog</a></li>
<li><a href="http://twitter.com/rails_apps" class="twitter">Twitter</a></li>
<li><a href="https://plus.google.com/117374718581973393536" class="google">Google +</a></li>
<li><a href="https://github.com/RailsApps" class="github">GitHub Repository</a></li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="content wikistyle gollum textile">
<h1>Rails with Git and GitHub</h1>
<h4>by Daniel Kehoe</h4>
<p><em>Last updated 8 June 2012</em></p>
<p>Using GitHub with Rails. <a href="http://git-scm.com/">Git</a> provides a source control repository. Use git to roll back code changes as needed, when you are collaborating with others, and when you create an app for deployment into production with a service such as Heroku.</p>
<p>If you are building a throw-away app for your own education, you may decide not to use git, but sooner or later you will need to learn to use git to participate in the open source community.</p>
<p>This is a guide for developers using the example apps from the <a href="http://railsapps.github.com/">Rails Apps</a> repository. Others may find it helpful as well.</p>
<h2>New to Git?</h2>
<p>If you arew new to git, you can read a free online version of the book <a href="http://git-scm.com/book">Pro Git</a> by Scott Chacon.</p>
<p>Check that git is installed on your computer:</p>
<pre>
$ git version
</pre>
<p>If you need to install git, refer to the section <a href="http://git-scm.com/book/en/Getting-Started-Installing-Git">Installing Git</a> from Scott Chacon’s book. Also see <a href="http://git-scm.com/book/en/Getting-Started-First-Time-Git-Setup">First-Time Git Setup</a> from the book.</p>
<p>Michael Hartl’s Rails Tutorial book also covers <a href="http://ruby.railstutorial.org/ruby-on-rails-tutorial-book?version=3.2#sec:version_control">Version Control with Git</a>.</p>
<h2>Git Config</h2>
<p>Check your git configuration parameters:</p>
<pre>
$ git config -l --global
user.name=Daniel Kehoe
</pre>
<p>The email address will identify you to any services that use your git repo, such as GitHub and Heroku.</p>
<h2>Ignore Files</h2>
<p>When you use the <code>rails new</code> command, Rails creates a <strong>.gitignore</strong> file for you in your application root directory. You may want to modify it:</p>
<pre>
.bundle
db/*.sqlite3
log/*.log
tmp/
.DS_Store
</pre>
<p>The RailsApps project has a more extensive <a href="https://github.com/RailsApps/rails3-application-templates/blob/master/files/gitignore.txt">example <strong>.gitignore</strong> file</a> you might want to examine.</p>
<h2>Initialize Git For Your Rails Application</h2>
<p>You’ll need to do this if you have created a new Rails application. If you’ve created a Rails application using an <a href="https://github.com/RailsApps/rails3-application-templates">application template</a> from the Rails Apps project, the application template will have done this for you already.</p>
<p>Be sure you are in your application’s root directory.</p>
<p>Initialize git and check in your first commit:</p>
<pre>
$ git init
$ git add .
$ git commit -m 'initial commit'
</pre>
<p>You can check your commit status at any time with:</p>
<pre>
$ git status
</pre>
<h2>Get a GitHub Account</h2>
<p>Use a GitHub repository if you want an offsite copy of your work or you plan to share your work with others.</p>
<p>Get a <a href="https://github.com/signup/free">free GitHub account</a> if you don’t already have one. It’s advisable to register using the email address that you’ve used to configure git locally (see “Git Config” above).</p>
<p>Check that your GitHub account is set up properly:</p>
<pre>
$ ssh -T -p 443 [email protected]
</pre>
<p>If your account is set up correctly, you’ll see a message:</p>
<pre>
Hi ...! You've successfully authenticated, but GitHub does not provide shell access.
</pre>
<p>The first time you connect, you will be warned (by ssh) that you have not previously connected with the host at ssh.github.com:</p>
<pre>
The authenticity of host '[ssh.github.com]:443 ...' can't be established.
Are you sure you want to continue connecting (yes/no)?
</pre>
<p>Unless you are the victim of a particularly insidious and unlikely exploit, you can safely answer “yes.”</p>
<p>If you see an error message such as <code>Host key verification failed</code>, review GitHub’s document <a href="http://help.github.com/set-up-git-redirect/">setting up Git and <span class="caps">SSH</span> keys</a> or the guide <a href="http://help.github.com/ssh-issues/">troubleshoot common <span class="caps">SSH</span> Problems</a>.</p>
<h2>Save it to GitHub</h2>
<p>Go to GitHub and create a new empty repository (<a href="http://github.com/repositories/new">http://github.com/repositories/new</a>) into which you can push your local git repo.</p>
<p>Add GitHub as a remote repository for your project and push your local project to the remote repository:</p>
<pre>
$ git remote add origin [email protected]:YOUR_GITHUB_ACCOUNT/YOUR_PROJECT_NAME.git
$ git push origin master
</pre>
<p>At each stage of completion, you should check your code into your local repository:</p>
<pre>
$ git commit -m "some helpful comment"
</pre>
<p>and then push it to the remote repository:</p>
<pre>
$ git push origin master
</pre>
<h2>Git Workflow</h2>
<p>When you are using git for version control, you can commit every time you save a file, even for the tiniest typo fixes. If only you will ever see your git commits, no one will care. But if you are working on a team, either commercially or as part of an open source project, you will drive your fellow programmers crazy if they try to follow your work and see such “granular” commits. Instead, get in the habit of creating a git branch each time you begin work to implement a feature. When your new feature is complete, merge the branch and “squash” the commits so your comrades see just one commit for the entire feature.</p>
<p>Here’s how to create a new git branch for a feature named “login”:</p>
<pre>
$ git checkout -b login
</pre>
<p>The command creates a new branch named “login” and switches to it, analogous to copying all your files to a new directory and moving to work in the new directory (though that is not really what happens with git).</p>
<p>When the new feature is complete, merge the working branch to “master” and squash the commits so you have just one commit for the entire feature:</p>
<pre>
$ git checkout master
$ git merge --squash login
$ git commit -am "implement 'login' feature"
</pre>
<p>You can delete the working branch when you’re done:</p>
<pre>
$ git branch -D login
</pre>
<p>Experienced git user? Have a recommendation? Leave a comment below.</p>
</div><!-- class="content" -->
<div class="comments">
<div class="content wikistyle gollum">
<h2>Comments</h2>
</div>
<p>Is this helpful? Please "like" below. Question or suggestion? Please add a comment below. Got a correction or addition? You can edit this page <a href="https://github.com/RailsApps/railsapps.github.com/wiki/_pages">on the wiki</a> or create a <a href="https://github.com/RailsApps/railsapps.github.com/issues">GitHub issue</a> to alert me.</p>
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'railsapps'; // required: replace example with your forum shortname
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</div><!-- class="comments" -->
<div class="footer row">
<div class="span4">
<h3>Credits</h3>
<p><a href="http://danielkehoe.com/">Daniel Kehoe</a> initiated the <a href="http://railsapps.github.com/">RailsApps Project</a>. Thanks to <a href="http://tigrish.com/">Christopher Dell</a> for design contributions.</p>
</div>
<div class="span4">
<h3>Contributions</h3>
<p>Corrections? Additions? You can edit this page <a href="https://github.com/RailsApps/railsapps.github.com/wiki/_pages">on the wiki</a>.</p>
</div>
<div class="span4">
<h3>Last edit</h3>
<p>by <b>Daniel Kehoe</b>, 2012-06-26 04:16:58</p>
</div>
</div>
</div>
</body>
</html>