Changes between Version 1 and Version 2 of Chimera2/git

Timestamp:

May 1, 2013, 11:45:11 AM (13 years ago)

Author:

Conrad Huang

Comment:

--

Chimera2/git

@@ +1 @@
+[[PageOutline]]
+
 = Chimera 2 Revision Control =
 
-We will use '''git''' and '''git flow''' for revision control to manage Chimera 2 source code.  Development will follow the [http://nvie.com/posts/a-successful-git-branching-model/ Vincent Driessen's branching model] where the '''master''' branch is the release branch and the '''develop''' branch is the daily build branch.  The remainder of this document describes some common tasks using '''git'''.
+We will use '''git''' and '''git flow''' for revision control to manage Chimera 2 source code.  Development will follow the [http://nvie.com/posts/a-successful-git-branching-model/ Vincent Driessen's branching model] where the '''master''' branch is the release branch and the '''develop''' branch is the daily build branch.  A ''team repository'' is the repository that is used to create release and daily builds, ''i.e.'', changes committed in developer repositories but not pushed to the team repository will not appear in either release or daily builds.
 
-[[PageOutline]]
+The remainder of this document describes some common tasks using '''git'''.
 
-== Create Team Repository ==
 == Create Developer Repository on plato ==
-== Use '''develop''' Branch Directly for Development ==
+== Use ''develop'' Branch Directly for Development ==
 == Use Feature Branch for Development ==
 == Stash Modified Files before Switching Branches ==
 == Create Remote Repository ==
 == Use plato Repository to Coordinate Development on Multiple Hosts ==
+== Create Team Repository ==
+
+In this section, examples refer to ''/var/tmp/conrad/example'' since the actual path ''/usr/local/projects/chimera2/git'' is already in use.  Examples in other sections of this document refer to the correct path.
+
+Create the bare '''git''' repository that will serve as the team repository for Chimera 2 source code.  Note that the repository is created for sharing within a group.  The '''chgrp''' command defines which group will have cloning and update privileges.  The access permissions such as the setgid bit of directories (meaning files created will inherit the group of the parent directory) in the repository is maintained by '''git''' and should not require manual intervention.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:example conrad$ cd /var/tmp/conrad/example</b>
+<b style="color:#c22;">franklin:example conrad$ git init --bare --shared=group chimera2.git</b>
+Initialized empty shared Git repository in /var/tmp/conrad/example/chimera2.git/
+<b style="color:#c22;">franklin:example conrad$ chgrp -R chimdev chimera2.git</b>
+<b style="color:#c22;">franklin:example conrad$ ls -l</b>
+total 4
+drwxrwsr-x 7 conrad chimdev 3864 May  1 09:34 chimera2.git/
+</pre>
+}}}
+
+Create a bootstrap repository so that we can set up the initial configuration for the project.  The reason this repository is temporary is that the push/pull linkage between local and remote branches need to be set up when the branches are created, but are handled automatically during cloning after they have been created.  Since we will only use '''master''' and '''develop''' branches in the team repository, we can set them up now and developers who clone later will not have to worry about configuring the push/pull targets.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:example conrad$ git clone --shared chimera2.git bootstrap</b>
+Initialized empty Git repository in /var/tmp/conrad/example/bootstrap/.git/
+warning: You appear to have cloned an empty repository.
+<b style="color:#c22;">franklin:example conrad$ cd bootstrap</b>
+/var/tmp/conrad/example/bootstrap
+<b style="color:#c22;">franklin:bootstrap conrad$ ls -la</b>
+total 12
+drwxr-xr-x 3 conrad ferrin 3864 May  1 10:32 ./
+drwxrwxr-x 5 conrad ferrin 3864 May  1 10:32 ../
+drwxrwxr-x 7 conrad ferrin 3864 May  1 10:32 .git/
+</pre>
+}}}
+
+Use '''git flow''' to set up the branches in the bootstrap repository.  After initialization, we are on the '''develop''' branch where we add our initial files; '''xyzzy''' is our only file in this example.  The '''add -A''' command adds all modified and untracked files to the staging area; the '''commit''' command commits files in the staging area to the local repository; the '''push''' command pushes the state of the current branch from the local repository, '''bootstrap''', to the remote team repository, '''origin''', which represents the repository from which we are cloned ('''chimera2.git''' in this case).
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:bootstrap conrad$ git flow init -d</b>
+Using default branch names.
+No branches exist yet. Base branches must be created now.
+Branch name for production releases: [master]
+Branch name for "next release" development: [develop]
+
+How to name your supporting branch prefixes?
+Feature branches? [feature/]
+Release branches? [release/]
+Hotfix branches? [hotfix/]
+Support branches? [support/]
+Version tag prefix? []
+<b style="color:#c22;">franklin:bootstrap conrad$ git status</b>
+# On branch develop
+nothing to commit (working directory clean)
+<b style="color:#c22;">franklin:bootstrap conrad$ echo hello > xyzzy</b>
+<b style="color:#c22;">franklin:bootstrap conrad$ git add -A</b>
+<b style="color:#c22;">franklin:bootstrap conrad$ git status</b>
+# On branch develop
+# Changes to be committed:
+#   (use "git reset HEAD &lt;file&gt;..." to unstage)
+#
+#       new file:   xyzzy
+#
+<b style="color:#c22;">franklin:bootstrap conrad$ git commit -m "initial setup"</b>
+[develop ff9b042] initial setup
+ 1 files changed, 1 insertions(+), 0 deletions(-)
+ create mode 100644 xyzzy
+<b style="color:#c22;">franklin:bootstrap conrad$ git push origin develop</b>
+Counting objects: 5, done.
+Delta compression using up to 64 threads.
+Compressing objects: 100% (2/2), done.
+Writing objects: 100% (5/5), 384 bytes, done.
+Total 5 (delta 0), reused 0 (delta 0)
+Unpacking objects: 100% (5/5), done.
+To /var/tmp/conrad/example/chimera2.git
+ * [new branch]      develop -> develop
+</pre>
+}}}
+
+Make the '''master''' branch match the '''develop''' branch.  The '''checkout''' command is used to switch from one branch to another; note that this command only uses the __local__ repository and does not require access to the team repository.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:bootstrap conrad$ git checkout master</b>
+Switched to branch 'master'
+You have new mail in /var/spool/mail/conrad
+<b style="color:#c22;">franklin:bootstrap conrad$ git merge develop</b>
+Updating 76fd917..ff9b042
+Fast-forward
+ xyzzy |    1 +
+ 1 files changed, 1 insertions(+), 0 deletions(-)
+ create mode 100644 xyzzy
+<b style="color:#c22;">franklin:bootstrap conrad$ git push origin master</b>
+Total 0 (delta 0), reused 0 (delta 0)
+To /var/tmp/conrad/example/chimera2.git
+ * [new branch]      master -> master
+</pre>
+}}}
+
+At this point, the team repository set up is complete.  All the files are under revision control and the bootstrap repository may be safely deleted.  The team repository, '''chimera2.git''', with '''master''' and '''develop''' branches, is ready for by developers.  Note that developers still have to set up and use '''git flow''' after cloning in order to follow the [http://nvie.com/posts/a-successful-git-branching-model/ Vincent Driessen's branching model] conveniently.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:bootstrap conrad$ cd ..</b>
+<b style="color:#c22;">franklin:example conrad$ ls -l</b>
+total 12
+drwxr-xr-x 3 conrad ferrin  3864 May  1 11:19 bootstrap/
+drwxrwsr-x 7 conrad chimdev 3864 May  1 09:34 chimera2.git/
+<b style="color:#c22;">franklin:example conrad$ rm -rf bootstrap</b>
+</pre>
+}}}