General updates (#1653)

* Update README and shipping-releases as they are a bit out of date * Update year/copyright info * Update cake.frosting to latest for newest dotnet tooling support, and adjust builds for new configuration parameters * update xunit packages so codelens works for nested test classes (VS2017 15.3 update is also required) * Fixup VS version and remove win debugging tools
octokit · Aug 16, 2017 · 7114bcb · 7114bcb
1 parent ff9521c
commit 7114bcb
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 57 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2012 GitHub, Inc.
+Copyright (c) 2017 GitHub, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of 
 this software and associated documentation files (the "Software"), to deal in 

diff --git a/Octokit.Tests.Conventions/Octokit.Tests.Conventions.csproj b/Octokit.Tests.Conventions/Octokit.Tests.Conventions.csproj
@@ -38,7 +38,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
     <PackageReference Include="xunit" Version="2.2.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta4-build3742" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Octokit.Tests.Conventions/Properties/AssemblyInfo.cs b/Octokit.Tests.Conventions/Properties/AssemblyInfo.cs
@@ -10,7 +10,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("Octokit.Tests.Conventions")]
-[assembly: AssemblyCopyright("Copyright ©  2014")]
+[assembly: AssemblyCopyright("Copyright © 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 

diff --git a/Octokit.Tests.Integration/Octokit.Tests.Integration.csproj b/Octokit.Tests.Integration/Octokit.Tests.Integration.csproj
@@ -36,7 +36,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
     <PackageReference Include="xunit" Version="2.2.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta4-build3742" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Octokit.Tests.Integration/Properties/AssemblyInfo.cs b/Octokit.Tests.Integration/Properties/AssemblyInfo.cs
@@ -9,9 +9,9 @@
 [assembly: AssemblyTitle("Octokit.Tests.Integration")]
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("Microsoft")]
+[assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("Octokit.Tests.Integration")]
-[assembly: AssemblyCopyright("Copyright © Microsoft 2012")]
+[assembly: AssemblyCopyright("Copyright © 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 

diff --git a/Octokit.Tests/Octokit.Tests.csproj b/Octokit.Tests/Octokit.Tests.csproj
@@ -41,7 +41,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
     <PackageReference Include="xunit" Version="2.2.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta4-build3742" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net452' ">

diff --git a/Octokit.Tests/Properties/AssemblyInfo.cs b/Octokit.Tests/Properties/AssemblyInfo.cs
@@ -8,9 +8,9 @@
 [assembly: AssemblyTitle("Octokit.Tests")]
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("Microsoft")]
+[assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("Octokit.Tests")]
-[assembly: AssemblyCopyright("Copyright © Microsoft 2012")]
+[assembly: AssemblyCopyright("Copyright © 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 

diff --git a/README.md b/README.md
@@ -26,16 +26,19 @@ Console.WriteLine(user.Followers + " folks love the half ogre!");
 
 ## Getting Started
 
-Octokit is available on NuGet.
+Octokit is a GitHub API client library for .NET and is available on NuGet:
 
 ```
 Install-Package Octokit
 ```
-or an IObservable based GitHub API client library for .NET using Reactive Extensions
+
+There is also an IObservable based GitHub API client library for .NET using Reactive Extensions:
 
 ```
 Install-Package Octokit.Reactive
 ```
+
+
 ### Beta packages ###
 Unstable NuGet packages that track the master branch of this repository are available at
 [https://ci.appveyor.com/nuget/octokit-net](https://ci.appveyor.com/nuget/octokit-net)
@@ -48,21 +51,22 @@ Documentation is available at http://octokitnet.readthedocs.io/en/latest/.
 
 ## Build
 
-Octokit is a single assembly designed to be easy to deploy anywhere. If you
-prefer to compile it yourself, you’ll need:
-
-* Visual Studio 2015 or Xamarin Studio
-* Windows 8.1 or higher to build and test the WinRT projects
+Octokit is a single assembly designed to be easy to deploy anywhere.
 
-To clone it locally click the "Clone in Desktop" button above or run the 
+To clone and build it locally click the "Clone in Desktop" button above or run the 
 following git commands.
 
 ```
 git clone [email protected]:octokit/Octokit.net.git Octokit
 cd Octokit
-.\build.cmd
 ```
 
+To build the libraries, run the following command:
+
+Windows: `.\build.ps1`
+
+Linux/OSX: `./build.sh`
+
 ## Contribute
 
 Visit the [Contributor Guidelines](https://github.com/octokit/octokit.net/blob/master/CONTRIBUTING.md)
@@ -95,6 +99,6 @@ problem.
 
 ## Copyright and License
 
-Copyright 2013 GitHub, Inc.
+Copyright 2017 GitHub, Inc.
 
 Licensed under the [MIT License](https://github.com/octokit/octokit.net/blob/master/LICENSE.txt)
diff --git a/build/Build.csproj b/build/Build.csproj
@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Frosting" Version="0.1.0-alpha0059" />
+    <PackageReference Include="Cake.Frosting" Version="0.1.0-alpha0071" />
   </ItemGroup>
 
 </Project>
diff --git a/build/Context.cs b/build/Context.cs
@@ -31,8 +31,7 @@ public DotNetCoreTestSettings GetTestSettings()
         var settings = new DotNetCoreTestSettings
         {
             Configuration = Configuration,
-            NoBuild = true,
-            Verbose = false
+            NoBuild = true
         };
 
         if (!this.IsRunningOnWindows())

diff --git a/build/Tasks/IntegrationTests.cs b/build/Tasks/IntegrationTests.cs
@@ -12,12 +12,7 @@ public override void Run(Context context)
         foreach (var project in context.Projects.Where(x => x.IntegrationTests))
         {
             context.Information("Executing Integration Tests Project {0}...", project.Name);
-            context.DotNetCoreTest(project.Path.FullPath, new DotNetCoreTestSettings
-            {
-                Configuration = context.Configuration,
-                NoBuild = true,
-                Verbose = false
-            });
+            context.DotNetCoreTest(project.Path.FullPath, context.GetTestSettings());
         }
     }
 

diff --git a/build/Tasks/Package.cs b/build/Tasks/Package.cs
@@ -20,7 +20,6 @@ public override void Run(Context context)
                 {
                     Configuration = context.Configuration,
                     NoBuild = true,
-                    Verbose = false,
                     OutputDirectory = context.Artifacts,
                     ArgumentCustomization = args => args.Append("/p:Version={0}", context.Version.GetSemanticVersion())
                 });

diff --git a/build/Tasks/Restore.cs b/build/Tasks/Restore.cs
@@ -7,9 +7,6 @@ public sealed class Restore : FrostingTask<Context>
 {
     public override void Run(Context context)
     {
-        context.DotNetCoreRestore(".", new DotNetCoreRestoreSettings
-        {
-            Verbose = false
-        });
+        context.DotNetCoreRestore(".");
     }
 }
diff --git a/docs/shipping-releases.md b/docs/shipping-releases.md
@@ -2,43 +2,31 @@
 
 ## Pre-requisites
 
- - Visual Studio 2013 Update 4
- - Debugging Tools for Windows (install via [Chocolatey](http://chocolatey.org) - `cinst windbg`)
+ - Visual Studio 2017 Update 3
 
 ### Running Tests
 
-Due to how long it takes to run the integration tests, I usually run these in groups in Visual Studio.
+Due to how long it takes to run the integration tests (and GitHub API rate limits), 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 IntegrationTests`
+> `.\build.ps1 -Target IntegrationTests`
 
-If you want to avoid these tests, or get faster feedback, you can run the other
-tests:
+If you want to avoid these tests, or get faster feedback, the Unit and Convention tests are run in the default target
+> `.\build.ps1`
 
-> `.\build UnitTests`
-> `.\build ConventionTests`
+Or can be run individually:
+
+> `.\build.ps1 -Target UnitTests`
+> `.\build.ps1 -Target ConventionTests`
 
 ### 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`
+NuGet packages are automatically generated (and SourceLinked) by the CAKE build script.
+> `.\build.ps1`
 
-This will build the assemblies, index the symbols and create the packages. The
-output .nupkg files will be located in the `packaging` directory.
+The output .nupkg files will be located in the `packaging` directory.