Merge branch 'release/2.0.0'

NextVersion.txt

@@ -0,0 +1 @@
+2.0.0

README.md

@@ -1,28 +1,59 @@
-GitHubLink
+GitLink
 ==========
 
-![GitHubLink](design/logo/logo_64.png)
+![GitLink](design/logo/logo_64.png)
 
-GitHubLink let's users step through your code hosted on GitHub! **Help making .NET open source projects more accessible by enabling this for your .NET projects, it's just a single additional step in your build**. See the list of [projects using GitHubLink](#ProjectsUsingGitHubLink).
+GitLink let's users step through your code hosted on GitHub! **Help make .NET open source projects more accessible by enabling this for your .NET projects, it's just a single additional step in your build**. See the list of [projects using GitLink](#projects-using-gitlink).
 
-GitHubLink makes symbol servers obsolete which saves you both time with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+-- 
 
-![Stepping through external source code](doc/images/GitHubLink_example.gif)  
+**Important note** 
 
+*GitLink* was formerly named *GitHubLink*. By adding support to more Git hosting services the name seemed not covering the whole package. Note that the old GitHubLink packages on NuGet and Chocolatey will no long be updated / maintained.
 
-This application is based on the <a href="https://github.com/ctaggart/SourceLink"  target="_blank">SourceLink project</a>. SourceLink requires FAKE to run and not everyone likes to write code in F#. GitHubLink is a wrapper around SourceLink specifically written to be easily used from any build system (locally or a build server) and in any .NET language. It also provides new features such as standard integration with GitHub and the possibility to use remote repositories. GitHubLink is available as console application and can be referenced as assembly to be used in other .NET assemblies.
+-- 
 
-The advantage of GitHubLink is that it is fully customized for GitHub. It also works with GitHub urls so it **does not require a local git repository to work**. This makes it perfectly usable in continuous integration servers such as <a href="http://www.finalbuilder.com/Continua-CI" target="_blank">Continua CI</a>.
+GitLink makes symbol servers obsolete which saves you both time with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+
+![Stepping through external source code](doc/images/GitLink_example.gif)  
+
+
+This application is based on the <a href="https://github.com/ctaggart/SourceLink"  target="_blank">SourceLink project</a>. SourceLink requires FAKE to run and not everyone likes to write code in F#. GitLink is a wrapper around SourceLink specifically written to be easily used from any build system (locally or a build server) and in any .NET language. It also provides new features such as standard integration with GitHub and BitBucket and the possibility to use remote repositories. GitLink is available as console application and can be referenced as assembly to be used in other .NET assemblies.
+
+The advantage of GitLink is that it is fully customized for Git. It also works with GitHub or BitBucket urls so it **does not require a local git repository to work**. This makes it perfectly usable in continuous integration servers such as <a href="http://www.finalbuilder.com/Continua-CI" target="_blank">Continua CI</a>.
 
 Updating all the pdb files is very fast. A solution with over 85 projects will be handled in less than 30 seconds.
 
-When using GitHubLink, the user no longer has to specify symbol servers. He/she only has to enable the support for source servers in Visual Studio as shown in the image below:
+When using GitLink, the user no longer has to specify symbol servers. He/she only has to enable the support for source servers in Visual Studio as shown in the image below:
 
 ![Enabling source server support](doc/images/visualstudio_enablesourceserversupport.png)  
 
-# Using GitHubLink as command line tool #
+**Note that Visual Studio 2012 needs to run elevated in order to download the source server files due to a bug in Visual Studio 2012.**
+
+# Supported git providers
+
+GitLink supports the following providers out of the box (will auto-detect based on the url):
 
-Using GitHubLink via the command line is very simple:
+* <a href="https://bitbucket.org/" target="_blank">BitBucket</a>
+* <a href="https://github.com/" target="_blank">GitHub</a>
+
+Providers currently being worked on:
+
+* <a href="https://www.assembla.com/home" target="_blank">Assembla</a>
+* <a href="http://beanstalkapp.com/" target="_blank">Beanstalk</a>
+* <a href="http://www.cloudforge.com/" target="_blank">CloudForge</a>
+* <a href="https://www.codebasehq.com/" target="_blank">Codebase</a>
+* <a href="https://www.fogcreek.com/kiln/" target="_blank">FogCreek</a>
+* <a href="https://plan.io/" target="_blank">Planio</a>
+* <a href="http://projectlocker.com/" target="_blank">ProjectLocker</a> 
+* <a href="https://rhodecode.com/" target="_blank">RhodeCode</a>
+* <a href="https://unfuddle.com/" target="_blank">Unfuddle</a>   
+
+It is also possible to specify a custom url provider.
+
+# Using GitLink as command line tool #
+
+Using GitLink via the command line is very simple:
 
 1. Build the software (in release mode with pdb files enabled)
 2. Run the console application with the right command line parameters
@@ -31,103 +62,114 @@ Below are a few examples.
 
 ## Running for the default branch ##
 
-    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel 
+    GitLink.exe c:\source\catel -u https://github.com/catel/catel 
 
 This will use the default branch (which is in most cases **master**). You can find out the default branch by checking what branch is loaded by default on the GitHub page.
 
 ## Running for a specific branch ##
 
-    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop
+    GitLink.exe c:\source\catel -u https://github.com/catel/catel -b develop
 
 This will use the develop branch.
 
 ## Running for a specific branch and configuration ##
 
-    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -c debug
+    GitLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -c debug
 
 This will use the develop branch and the debug configuration.
 
 ## Getting help ##
 
-When you need help about GitHubLink, use the following command line:
+When you need help about GitLink, use the following command line:
 
-    GitHubLink.exe -help
+    GitLink.exe -help
 
 ## Logging to a file ##
 
 When you need to log the information to a file, use the following command line:
 
-    GitHubLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -l GitHubLinkLog.log
+    GitLink.exe c:\source\catel -u https://github.com/catel/catel -b develop -l GitLinkLog.log
 
 
-# Using GitHubLink in code #
+# Using GitLink in code #
 
-GitHubLink is built with 2 usages in mind: command line and code reference. Though most people will use the command line version, it is possible to reference the executable and use the logic in code.
+GitLink is built with 2 usages in mind: command line and code reference. Though most people will use the command line version, it is possible to reference the executable and use the logic in code.
 
 The command line implementation uses the same available API. 
 
 ## Creating a context ##
 
-To link files to a GitHub project, a context must be created. The command line version does this by using the *ArgumentParser* class. It is also possible to create a context from scratch as shown in the example below:
+To link files to a Git project, a context must be created. The command line version does this by using the *ArgumentParser* class. It is also possible to create a context from scratch as shown in the example below:
 
-    var context = new GitHubLink.Context();
-    context.SolutionDirectory = @"c:\source\catel";
-    context.TargetUrl = "https://github.com/catel/catel";
-    context.TargetBranch = "develop";
+```csharp
+var context = new GitLink.Context();
+context.SolutionDirectory = @"c:\source\catel";
+context.TargetUrl = "https://github.com/catel/catel";
+context.TargetBranch = "develop";
+```
 
 It is possible to create a context based on command line arguments:
 
-    var context = ArgumentParser.Parse(@"c:\source\catel -u https://github.com/catel/catel -b develop");
+```csharp
+var context = ArgumentParser.Parse(@"c:\source\catel -u https://github.com/catel/catel -b develop");
+```
 
 ## Linking a context ##
 
 Once a context is created, the *Linker* class can be used to actually link the files:
 
     Linker.Link(context);
 
-# How to get GitHubLink #
+# How to get GitLink #
 
-There are three general ways to get GitHubLink:.
+There are three general ways to get GitLink:.
 
 ## Get it from GitHub ##
 
-The releases will be available as separate executable download on the [releases tab](https://github.com/GeertvanHorrik/GitHubLink/releases) of the project.
+The releases will be available as separate executable download on the [releases tab](https://github.com/CatenaLogic/GitLink/releases) of the project.
 
 ## Get it via Chocolatey ##
 
 If you want to install the tool on your (build) computer, the package is available via <a href="https://chocolatey.org/" target="_blank">Chocolatey</a>. To install, use the following command:
 
-    cinst GitHubLink
+    choco install GitLink
 
 ## Get it via NuGet ##
 
 If you want to reference the assembly to use it in code, the recommended way to get it is via <a href="http://www.nuget.org/" target="_blank">NuGet</a>. 
 
-**Note that getting GitHubLink via NuGet will add it as a reference to the project**
+**Note that getting GitLink via NuGet will add it as a reference to the project**
 
 # How does it work #
 
 The SrcSrv tool (Srcsrv.dll) enables a client to retrieve the exact version of the source files that were used to build an application. Because the source code for a module can change between versions and over the course of years, it is important to look at the source code as it existed when the version of the module in question was built.
 
 For more information, see the <a href="http://msdn.microsoft.com/en-us/library/windows/hardware/ff558791(v=vs.85).aspx" target="_blank">official documentation of SrcSrv</a>.
 
-GitHubLink creates a source index file and updates the PDB file so it will retrieve the files from the GitHub file handler.
+GitLink creates a source index file and updates the PDB file so it will retrieve the files from the Git host file handler.
 
-<a name="ProjectsUsingGitHubLink"></a>
-# Projects using GitHubLink #
+<a name="projects-using-gitlink"></a>
+# Projects using GitLink #
 
-Below is a list of projects already using GitHubLink (alphabetically ordered).
+Below is a list of projects already using GitLink (alphabetically ordered).
 
 - <a href="http://www.catelproject.com" target="_blank">Catel</a>
 - <a href="http://www.expandframework.com/" target="_blank">eXpand</a>
-- <a href="https://github.com/GeertvanHorrik/GitHubLink" target="_blank">GitHubLink</a>
-- <a href="https://github.com/orcomp/orchestra" target="_blank">Orchestra</a>
-
-Are you using GitHubLink in your projects? Let us know and we will add your project to the list.
+- <a href="https://github.com/CatenaLogic/GitLink" target="_blank">GitLink</a>
+- <a href="https://github.com/orcomp/Orc.CsvHelper" target="_blank">Orc.CsvHelper</a>
+- <a href="https://github.com/orcomp/Orc.FilterBuilder" target="_blank">Orc.FilterBuilder</a>
+- <a href="https://github.com/orcomp/Orc.ProjectManagement" target="_blank">Orc.ProjectManagement</a>
+- <a href="https://github.com/orcomp/Orc.Sort" target="_blank">Orc.Sort</a>
+- <a href="https://github.com/orcomp/Orchestra" target="_blank">Orchestra</a>
+- <a href="http://romanticweb.net" target="_blank">Romantic Web</a>
+- <a href="https://github.com/xunit/xunit" target="_blank">xUnit.net</a>
+- <a href="https://github.com/xunit/visualstudio.xunit" target="_blank">xUnit.net Visual Studio Runner</a>
+
+Are you using GitLink in your projects? Let us know and we will add your project to the list.
 
 *Note that you can also create a pull request on this document and add it yourself.* 
 
 
 # Icon #
 
-Link by Dominic Whittle from The Noun Project
+Link by Dominic Whittle from The Noun Project

deployment/Chocolatey/template/GitHubLink/GitHubLink.nuspec

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>githublink</id>
+    <version>[VERSION]</version>
+	<title>GitHubLink</title>
+    <authors>GeertvanHorrik</authors>
+
+	<description>
+	  ** Note: this is a maintenance package, GitHubLink is replaced by GitLink **
+	</description>
+
+	<summary>
+	</summary>
+
+	<tags>source symbol symbols server sourcelink github bitbucket git stepping debugging</tags>
+
+	<language>en-US</language>
+	<projectUrl>https://github.com/CatenaLogic/GitLink/</projectUrl>	
+	<licenseUrl>https://github.com/CatenaLogic/GitLink/blob/develop/LICENSE</licenseUrl>
+	<iconUrl>https://raw.githubusercontent.com/CatenaLogic/GitLink/develop/design/logo/logo_64.png</iconUrl>
+
+    <dependencies>
+      <dependency id="gitlink" version="[VERSION]" />
+    </dependencies>    
+  </metadata>
+</package>

deployment/Chocolatey/template/GitLink/GitLink.nuspec

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>gitlink</id>
+    <version>[VERSION]</version>
+	<title>GitLink</title>
+    <authors>GeertvanHorrik</authors>
+
+	<description>
+	  GitLink let's users step through your code hosted on any Git hosting service! This makes symbol servers obsolete which saves you both time 
+      with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+	</description>
+
+	<summary>
+	</summary>
+
+	<tags>gitlink githublinksource symbol symbols server sourcelink github bitbucket git stepping debugging</tags>
+
+	<language>en-US</language>
+	<projectUrl>https://github.com/CatenaLogic/GitLink/</projectUrl>	
+	<licenseUrl>https://github.com/CatenaLogic/GitLink/blob/develop/LICENSE</licenseUrl>
+	<iconUrl>https://raw.githubusercontent.com/CatenaLogic/GitLink/develop/design/logo/logo_64.png</iconUrl>
+  </metadata>
+</package>

deployment/Chocolatey/template/GitLink/tools/chocolateyInstall.ps1

@@ -0,0 +1,2 @@
+Generate-BinFile "ghl" "$packageFolder\Tools\GitLink.exe"
+Write-ChocolateySuccess "GitLink"

deployment/Chocolatey/template/GitLink/tools/chocolateyUninstall.ps1

@@ -0,0 +1,3 @@
+Remove-BinFile "gl" "$packageFolder\Tools\GitLink.exe"
+Remove-BinFile "GitLink" "$packageFolder\Tools\GitLink.exe"
+Write-ChocolateySuccess "GitLink"

deployment/NuGet/template/GitHubLink/GitHubLink.nuspec

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>githublink</id>
+    <version>[VERSION]</version>
+	<title>GitHubLink</title>
+    <authors>GeertvanHorrik</authors>
+
+	<description>
+	  ** Note: this is a maintenance package, GitHubLink is replaced by GitLink **
+	</description>
+
+	<summary>
+	</summary>
+
+	<tags>source symbol symbols server sourcelink github bitbucket git stepping debugging</tags>
+
+	<language>en-US</language>
+	<projectUrl>https://github.com/CatenaLogic/GitLink/</projectUrl>	
+	<licenseUrl>https://github.com/CatenaLogic/GitLink/blob/develop/LICENSE</licenseUrl>
+	<iconUrl>https://raw.githubusercontent.com/CatenaLogic/GitLink/develop/design/logo/logo_64.png</iconUrl>
+
+    <dependencies>
+      <dependency id="gitlink" version="[VERSION]" />
+    </dependencies>        
+  </metadata>
+</package>

deployment/NuGet/template/GitLink/GitLink.nuspec

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package>
+  <metadata>
+    <id>gitlink</id>
+    <version>[VERSION]</version>
+	<title>GitLink</title>
+    <authors>GeertvanHorrik</authors>
+
+	<description>
+	  GitLink let's users step through your code hosted on any Git hosting service! This makes symbol servers obsolete which saves you both time 
+      with uploading source files with symbols and the user no longer has to specify custom symbol servers (such as symbolsource.org).
+	</description>
+
+	<summary>
+	</summary>
+
+	<tags>gitlink githublink source symbol symbols server sourcelink github bitbucket git stepping debugging</tags>
+
+	<language>en-US</language>
+	<projectUrl>https://github.com/CatenaLogic/GitLink/</projectUrl>	
+	<licenseUrl>https://github.com/CatenaLogic/GitLink/blob/develop/LICENSE</licenseUrl>
+	<iconUrl>https://raw.githubusercontent.com/CatenaLogic/GitLink/develop/design/logo/logo_64.png</iconUrl>
+  </metadata>
+</package>