GitSharp/Examples

From eqqon

< GitSharp(Difference between revisions)

Latest revision as of 10:58, 5 June 2010

Playing around with git's objects

Repository

//Opening an existing git repository
repo = new Repository("path/to/repo");

// Now suppose you have created some new files and want to commit them
repo.Index.Add("README", "License.txt");
Commit commit = repo.Commit("My first commit with gitsharp", new Author("henon", "meinrad.recheis@gmail.com"));

// Easy, isn't it? Now let's have a look at the changes of this commit:
foreach (Change change in commit.Changes)
Console.WriteLine(change.Name + " " + change.ChangeType);

//Get the staged changes from the index
repo.Status.Added.Contains("README");

//Access and manipulate the configuration
repo.Config["core.autocrlf"] = "false";

Commit

// Get the message of the previous commit
string msg = new Commit(repo, "HEAD^").Message;
Debug.Assert(msg == repo.CurrentBranch.CurrentCommit.Parent.Message);

//Print a list of changes between two commits c1 and c2:
Commit c1 = repo.Get<Commit>( "979829389f136bfabb5956c68d909e7bf3092a4e"); // <-- note: short hashes are not yet supported
Commit c2 = new Commit(repo, "4a7455c2f23e0f7356877d1813594041c56e2db9");
foreach (Change change in c1.CompareAgainst(c2))
Console.WriteLine(change.ChangeType + ": " + change.Path);

//Print all previous commits of HEAD of the repository repo
foreach (Commit commit in repo.Head.CurrentCommit.Ancestors)
Console.WriteLine(commit.ShortHash + ": " + commit.Message + ", " + commit.Author.Name + ", " + commit.AuthorDate);

Tree & Leaf

//Get the root tree of the most recent commit
var tree = repo.Head.CurrentCommit.Tree;

//It has no Parent so IsRoot should be true
Debug.Assert(tree.Parent == null);
Debug.Assert(tree.IsRoot);

//Now you can browse throught that tree by iterating over its child trees
foreach (Tree subtree in tree.Trees)
Console.WriteLine(subtree.Path);

//Or printing the names of the files it contains
foreach (Leaf leaf in tree.Leaves)
Console.WriteLine(leaf.Path);

Blob

//A Leaf is a Blob and inherits from it a method to retrieve the data as a UTF8 encoded string:
string string_data = new Blob(repo, "49322bb17d3acc9146f98c97d078513228bbf3c0").Data;

// Blob also let's you access the raw data as byte array
byte[] byte_data = new Blob(repo, "49322bb17d3acc9146f98c97d078513228bbf3c0").RawData;

Branch

//Get the current branch
var branch = repo.CurrentBranch;
Console.WriteLine("Current branch is " + branch.Name);

//Another way to get the current branch
Branch head = repo.Head;

// check if head == master
Debug.Assert(head.Name == "master");

//Get master branch

var master = new Branch(repo, "master");
Debug.Assert(master == repo.Get<Branch>("master"));

//Get the abbreviated hash of the last commit on master
Console.WriteLine(master.CurrentCommit.ShortHash);

//Create a new branch
var b = GitSharp.Branch.Create(repo, "foo");

// Switching to our new branch
b.Checkout();

//Check if foo is current branch
Debug.Assert(b.IsCurrent);

//Reset the branch to a previous commit (hard or soft or mixed)
master.Reset("HEAD^", ResetBehavior.Hard);
master.Reset("49322bb17d3acc9146f98c97d078513228bbf3c0", ResetBehavior.Soft);
master.Reset("master", ResetBehavior.Mixed);

Using git commands

Init

//Initializing a new repository in the current directory (if GID_DIR environment variable is not set)
Git.Init(".");

//Initializing a new repository in the specified location
Git.Init("path/to/repo");

//Initializing a new repository with options
var cmd = new InitCommand { GitDirectory ="path/to/repo", Quiet = false, Bare = true };
cmd.Execute();

Clone

//Clone a repository from a public repository via http
Git.Clone("git://github.com/henon/GitSharp.git", "path/to/local/copy");

// Or using options
Git.Clone(new CloneCommand { Source = "git://github.com/henon/GitSharp.git", GitDirectory = "path/to/local/copy", Quiet = false, Bare = true });

@@ Line 34: / Line 34: @@
 === Tree & Leaf ===
-Get the root tree of the most recent commit
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Get the root tree of the most recent commit</span><br />
-{{code|<nowiki>var tree = repo.Head.CurrentCommit.Tree</nowiki>}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>var<span class="S0"> </span>tree<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span>repo<span class="S10">.</span>Head<span class="S10">.</span>CurrentCommit<span class="S10">.</span>Tree<span class="S10">;</span><br />
+<br />
-It has no Parent so IsRoot should be true
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//It has no Parent so IsRoot should be true</span><br />
-{{code|<nowiki>Debug.Assert(tree.Parent==null);</nowiki><br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Debug<span class="S10">.</span>Assert<span class="S10">(</span>tree<span class="S10">.</span>Parent<span class="S0"> </span><span class="S10">==</span><span class="S0"> </span><span class="S5">null</span><span class="S10">);</span><br />
-Debug.Assert(tree.IsRoot);}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Debug<span class="S10">.</span>Assert<span class="S10">(</span>tree<span class="S10">.</span>IsRoot<span class="S10">);</span><br />
+<br />
-Now you can browse throught that tree by iterating over its child trees
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Now you can browse throught that tree by iterating over its child trees</span><br />
-{{code|<nowiki>foreach(var subtree in tree.Trees) { ... }</nowiki>}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S5">foreach</span><span class="S0"> </span><span class="S10">(</span>Tree<span class="S0"> </span>subtree<span class="S0"> </span><span class="S5">in</span><span class="S0"> </span>tree<span class="S10">.</span>Trees<span class="S10">)</span><br />
+<span class="S0">&nbsp; &nbsp; &nbsp; &nbsp; </span>Console<span class="S10">.</span>WriteLine<span class="S10">(</span>subtree<span class="S10">.</span>Path<span class="S10">);</span><br />
-Or printing the names of the files it contains
+<br />
-{{code|<nowiki>foreach(var leaf in tree.Leaves) { Console.WriteLine( leaf.Path); }</nowiki>}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Or printing the names of the files it contains</span><br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S5">foreach</span><span class="S0"> </span><span class="S10">(</span>Leaf<span class="S0"> </span>leaf<span class="S0"> </span><span class="S5">in</span><span class="S0"> </span>tree<span class="S10">.</span>Leaves<span class="S10">)</span><br />
+<span class="S0">&nbsp; &nbsp; &nbsp; &nbsp; </span>Console<span class="S10">.</span>WriteLine<span class="S10">(</span>leaf<span class="S10">.</span>Path<span class="S10">);</span><br />
 === Blob ===
-A Leaf is a Blob and inherits from it a method to retrieve the data as a UTF8 encoded string:
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//A Leaf is a Blob and inherits from it a method to retrieve the data as a UTF8 encoded string:</span><br />
-{{code|new Blob(repo, "49322bb17d3acc9146f98c97d078513228bbf3c0").Data}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S5">string</span><span class="S0"> </span>string_data<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">new</span><span class="S0"> </span>Blob<span class="S10">(</span>repo<span class="S10">,</span><span class="S0"> </span><span class="S6">"49322bb17d3acc9146f98c97d078513228bbf3c0"</span><span class="S10">).</span>Data<span class="S10">;</span><br />
+<br />
-Blob also let's you access the raw data as byte array
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">// Blob also let's you access the raw data as byte array</span><br />
-{{code|new Blob(repo, "49322bb17d3acc9146f98c97d078513228bbf3c0").RawData}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S5">byte</span><span class="S10">[]</span><span class="S0"> </span>byte_data<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">new</span><span class="S0"> </span>Blob<span class="S10">(</span>repo<span class="S10">,</span><span class="S0"> </span><span class="S6">"49322bb17d3acc9146f98c97d078513228bbf3c0"</span><span class="S10">).</span>RawData<span class="S10">;</span><br />
 === Branch ===
-Get the current branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Get the current branch</span><br />
-{{code|var branch<nowiki>=</nowiki>repo.CurrentBranch<br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>var<span class="S0"> </span>branch<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span>repo<span class="S10">.</span>CurrentBranch<span class="S10">;</span><br />
-Console.WriteLine("Current branch is "+branch.Name);}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Console<span class="S10">.</span>WriteLine<span class="S10">(</span><span class="S6">"Current branch is "</span><span class="S0"> </span><span class="S10">+</span><span class="S0"> </span>branch<span class="S10">.</span>Name<span class="S10">);</span><br />
+<br />
-Another way to get the current branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Another way to get the current branch</span><br />
-{{code|repo.Head}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Branch<span class="S0"> </span>head<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span>repo<span class="S10">.</span>Head<span class="S10">;</span><br />
+<br />
-Get master branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">// check if head == master</span><br />
-{{code|var master <nowiki>=</nowiki> new Branch(repo, "master");}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Debug<span class="S10">.</span>Assert<span class="S10">(</span>head<span class="S10">.</span>Name<span class="S0"> </span><span class="S10">==</span><span class="S0"> </span><span class="S6">"master"</span><span class="S10">);</span><br />
+<br />
-Get the abbreviated hash of the last commit on master
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Get master branch</span><br />
-{{code|master.CurrentCommit.ShortHash}}
+<br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>var<span class="S0"> </span>master<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">new</span><span class="S0"> </span>Branch<span class="S10">(</span>repo<span class="S10">,</span><span class="S0"> </span><span class="S6">"master"</span><span class="S10">);</span><br />
-Create a new branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Debug<span class="S10">.</span>Assert<span class="S10">(</span>master<span class="S0"> </span><span class="S10">==</span><span class="S0"> </span>repo<span class="S10">.</span>Get<span class="S10">&lt;</span>Branch<span class="S10">&gt;(</span><span class="S6">"master"</span><span class="S10">));</span><br />
-{{code|var b <nowiki>=</nowiki> Branch.Create(repo, "foo");}}
+<br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Get the abbreviated hash of the last commit on master</span><br />
-ways to switch to our new branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Console<span class="S10">.</span>WriteLine<span class="S10">(</span>master<span class="S10">.</span>CurrentCommit<span class="S10">.</span>ShortHash<span class="S10">);</span><br />
-{{code|b.Checkout();<br>
+<br />
-new Branch(repo, "foo").Checkout();<br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Create a new branch</span><br />
-repo["foo"].Checkout();<br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>var<span class="S0"> </span>b<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span>GitSharp<span class="S10">.</span>Branch<span class="S10">.</span>Create<span class="S10">(</span>repo<span class="S10">,</span><span class="S0"> </span><span class="S6">"foo"</span><span class="S10">);</span><br />
-Branch.SwitchTo(b);<br>
+<br />
-Branch.SwitchTo("foo");<br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">// Switching to our new branch</span><br />
-repo.CheckoutBranch("foo");<br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>b<span class="S10">.</span>Checkout<span class="S10">();</span><br />
-repo.CheckoutBranch(b);}}
+<br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Check if foo is current branch</span><br />
-Check if foo is current branch
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Debug<span class="S10">.</span>Assert<span class="S10">(</span>b<span class="S10">.</span>IsCurrent<span class="S10">);</span><br />
-{{code|Assert.IsTrue( b.IsCurrent );}}
+<br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Reset the branch to a previous commit (hard or soft or mixed)</span><br />
-Reset the branch to a previous commit (hard or soft)
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>master<span class="S10">.</span>Reset<span class="S10">(</span><span class="S6">"HEAD^"</span><span class="S10">,</span><span class="S0"> </span>ResetBehavior<span class="S10">.</span>Hard<span class="S10">);</span><br />
-{{code|master.Reset("HEAD^", ResetBehavior.Hard)}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>master<span class="S10">.</span>Reset<span class="S10">(</span><span class="S6">"49322bb17d3acc9146f98c97d078513228bbf3c0"</span><span class="S10">,</span><span class="S0"> </span>ResetBehavior<span class="S10">.</span>Soft<span class="S10">);</span><br />
-{{code|master.Reset("HEAD^", ResetBehavior.Soft)}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>master<span class="S10">.</span>Reset<span class="S10">(</span><span class="S6">"master"</span><span class="S10">,</span><span class="S0"> </span>ResetBehavior<span class="S10">.</span>Mixed<span class="S10">);</span><br />
 == Using git commands ==
 === Init ===
-Initializing a new repository in the current directory (if GID_DIR environment variable is not set)
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Initializing a new repository in the current directory (if GID_DIR environment variable is not set)</span><br />
-{{code|GitSharp.Commands.Init();}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Git<span class="S10">.</span>Init<span class="S10">(</span><span class="S6">"."</span><span class="S10">);</span><br />
+<br />
-Initializing a new repository in the specified location
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Initializing a new repository in the specified location</span><br />
-{{code|GitSharp.Commands.Init("path/to/repo");}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Git<span class="S10">.</span>Init<span class="S10">(</span><span class="S6">"path/to/repo"</span><span class="S10">);</span><br />
+<br />
-Initializing a new repository with options
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Initializing a new repository with options</span><br />
-{{code|<nowiki>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>var<span class="S0"> </span>cmd<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">new</span><span class="S0"> </span>InitCommand<span class="S0"> </span><span class="S10">{</span><span class="S0"> </span>GitDirectory<span class="S0"> </span><span class="S10">=</span><span class="S6">"path/to/repo"</span><span class="S10">,</span><span class="S0"> </span>Quiet<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">false</span><span class="S10">,</span><span class="S0"> </span>Bare<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">true</span><span class="S0"> </span><span class="S10">};</span><br />
-var cmd = new GitSharp.InitCommand("path/to/repo") { Quiet=false, Bare=true };</nowiki><br>
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>cmd<span class="S10">.</span>Execute<span class="S10">();</span><br />
-cmd.Execute();
-}}
 == Clone ==
-Clone a repository from a public repository via http
-{{code|GitSharp.Commands.Clone("git://github.com/henon/GitSharp.git", "path/to/local/copy"); }}
-Or using options
-{{code|<nowiki>GitSharp.Commands.Clone(new CloneCommand() { Source="git://github.com/henon/GitSharp.git", GitDirectory="path/to/local/copy", Quiet=false, Bare=true});</nowiki>}}
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">//Clone a repository from a public repository via http</span><br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Git<span class="S10">.</span>Clone<span class="S10">(</span><span class="S6">"git://github.com/henon/GitSharp.git"</span><span class="S10">,</span><span class="S0"> </span><span class="S6">"path/to/local/copy"</span><span class="S10">);</span><br />
+<br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span><span class="S2">// Or using options</span><br />
+<span class="S0">&nbsp; &nbsp; &nbsp; </span>Git<span class="S10">.</span>Clone<span class="S10">(</span><span class="S5">new</span><span class="S0"> </span>CloneCommand<span class="S0"> </span><span class="S10">{</span><span class="S0"> </span>Source<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S6">"git://github.com/henon/GitSharp.git"</span><span class="S10">,</span><span class="S0"> </span>GitDirectory<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S6">"path/to/local/copy"</span><span class="S10">,</span><span class="S0"> </span>Quiet<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">false</span><span class="S10">,</span><span class="S0"> </span>Bare<span class="S0"> </span><span class="S10">=</span><span class="S0"> </span><span class="S5">true</span><span class="S0"> </span><span class="S10">});</span><br />
+<br />