Merge pull request #621 from octokit/release-0.6.0

Release 0.6.0

.gitattributes

@@ -2,7 +2,7 @@
 * text=auto
 
 # Text files that should be normalized to LF in odb.
-*.cs     text diff=csharp
+*.cs     text eol=lf diff=csharp
 *.xaml   text
 *.config text
 *.c      text
@@ -40,3 +40,6 @@
 *.pdb    binary
 *.sdf    binary
 *.7z     binary
+
+# Generated file should just use CRLF, it's fiiine
+SolutionInfo.cs text eol=crlf diff=csharp

CONTRIBUTING.md

@@ -96,15 +96,16 @@ Run this command to confirm all the tests pass: `.\build`
 ### Running integration tests
 
 Octokit has integration tests that access the GitHub API, but they must be 
-configured before they will be executed. To configure the tests, create a 
-test GitHub account (i.e., don't use your real GitHub account) and a test 
-organization owned by that account. Then set the following environment variables:
+configured before they will be executed.
+
+**Note:** To run the tests, we highly recommend you create a test GitHub
+account (i.e., don't use your real GitHub account) and a test organization
+owned by that account. Then set the following environment variables:
 
 `OCTOKIT_GITHUBUSERNAME` (set this to the test account's username)
 `OCTOKIT_GITHUBPASSWORD` (set this to the test account's password)
 `OCTOKIT_GITHUBORGANIZATION` (set this to the test account's organization)
 
-
 Once these are set, the integration tests will be executed both when 
 running the FullBuild MSBuild target, and when running the 
 Octokit.Tests.Integration assembly through an xUnit.net-friendly test runner.

Octokit.Tests.Integration/Clients/MiscellaneousClientTests.cs

@@ -33,8 +33,7 @@ public class MiscellaneousClientTests
             
             var result = await github.Miscellaneous.RenderRawMarkdown("This is\r\n a **test**");
 
-            Assert.Equal("<p>This is a <strong>test</strong></p>\n", result);
-            //Assert.Equal("<p>This is\n a <strong>test</strong></p>\n", result);
+            Assert.Equal("<p>This is\n a <strong>test</strong></p>\n", result);
         }
     }
 }

Octokit/Octokit-netcore45.csproj

@@ -355,10 +355,7 @@
     </CodeAnalysisDictionary>
   </ItemGroup>
   <ItemGroup />
-  <PropertyGroup Condition=" '$(VisualStudioVersion)' == '' or '$(VisualStudioVersion)' &lt; '11.0' ">
-    <VisualStudioVersion>11.0</VisualStudioVersion>
-  </PropertyGroup>
-  <Import Project="$(MSBuildExtensionsPath)\Microsoft\WindowsXaml\v$(VisualStudioVersion)\Microsoft.Windows.UI.Xaml.CSharp.targets" />
+  <Import Project="$(MSBuildExtensionsPath)\Microsoft\WindowsXaml\v12.0\Microsoft.Windows.UI.Xaml.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="BeforeBuild">

ReleaseNotes.md

@@ -1,3 +1,9 @@
+### New in 0.6.0 (Released 2014/12/15)
+* Fixed: Typo in guard clause for `ApiInfo` - #588 via @karlbohlmark
+* Fixed: Documentation typos in `NewRepository` - #590 via @karlbohlmark
+* Fixed: `Files` array now included when fetching a commit - #608 via @kzu
+* Fixed: `GetAllContributors` return `Contributions` count - #614 via @SimonCropp
+
 ### New in 0.5.3 (Released 2014/12/05)
 * New: Uploading release assets now supports an optional timeout value - #587 via @shiftkey
 

SolutionInfo.cs

@@ -3,11 +3,11 @@ using System.Reflection;
 using System.Runtime.InteropServices;
 
 [assembly: AssemblyProductAttribute("Octokit")]
-[assembly: AssemblyVersionAttribute("0.5.3")]
-[assembly: AssemblyFileVersionAttribute("0.5.3")]
+[assembly: AssemblyVersionAttribute("0.6.0")]
+[assembly: AssemblyFileVersionAttribute("0.6.0")]
 [assembly: ComVisibleAttribute(false)]
 namespace System {
     internal static class AssemblyVersionInformation {
-        internal const string Version = "0.5.3";
+        internal const string Version = "0.6.0";
     }
 }

build.fsx

@@ -190,9 +190,13 @@ Target "CreatePackages" DoNothing
 "IntegrationTests"
    ==> "Default"
 
+"SourceLink"
+   ==> "CreatePackages"
 "CreateOctokitPackage"
    ==> "CreatePackages"
 "CreateOctokitReactivePackage"
    ==> "CreatePackages"
 
+
+
 RunTargetOrDefault "Default"

docs/debugging-source.md

@@ -0,0 +1,32 @@
+# Debugging Octokit Source in your app
+
+As of version 0.6, Octokit supports symbol debugging - this enables you to step
+into the Octokit source without having the repository on your local machine.
+
+### Enable Symbol Debugging
+
+To enable this, you need to enable this in VS:
+
+ - From the top **Tools** menu, select **Options**
+ - Select **Debugging** from the left sidebar and expand **General**
+
+Ensure you have checked **Enable source server support**:
+
+![Enable source server support](https://cloud.githubusercontent.com/assets/359239/5388961/31f9b29e-8144-11e4-8c47-08aca6dee697.png)
+
+### How does this actually work?
+
+When you hit a breakpoint in your application, you can step into the
+Octokit source code using `F11`. This will retrieve the source file associated
+with a specific type, and cache it in your local symbols cache.
+
+![F11 step into symbol](https://cloud.githubusercontent.com/assets/359239/5389259/74600502-8149-11e4-94f7-10dc79a0573f.gif)
+
+You can then set subsequent breakpoints inside the source code, to return to 
+in the debugging session.
+
+### Acknowledgements
+
+Thanks to [Cameron Taggart](http://blog.ctaggart.com/) for building the
+[SourceLink](https://github.com/ctaggart/SourceLink) framework which we use
+to support this behaviour.

docs/shipping-releases.md

@@ -0,0 +1,44 @@
+# Shipping an Octokit Release
+
+## Pre-requisites
+
+ - Visual Studio 2013 Update 4
+ - Debugging Tools for Windows (install via [Chocolatey](http://chocolatey.org) - `cinst windbg`)
+
+### Running Tests
+
+Due to how long it takes to run the integration tests, I usually run these in groups in Visual Studio.
+
+If, however, you still want to do this, it's available from the command line:
+
+> `.\build RunIntegrationTests`
+
+If you want to avoid these tests, or get faster feedback, you can run the other
+tests:
+
+> `.\build RunUnitTests`
+> `.\build RunConventionTests`
+
+### Signing Assemblies
+
+**TODO**
+
+### Create NuGet Packages
+
+To generate the NuGet packages, you also need to setup the SourceLink tools.
+
+Set this for the repository:
+
+> git config core.autocrlf input
+
+If you already have an existing repository, just run these steps to ensure you're using the right line endings:
+
+> git rm -r -cached .
+> git reset --hard
+
+Once you've done that, just run this:
+
+> `.\build CreatePackages`
+
+This will build the assemblies, index the symbols and create the packages. The
+output .nupkg files will be located in the `packaging` directory.