zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-05 23:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

General updates (#1653)

Browse Source 
* 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
This commit is contained in:
Ryan Gribble
2017-08-16 21:33:03 +10:00
committed by GitHub
parent ff9521ce3d
commit 7114bcb41e
14 changed files with 39 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE.txt
View File

@@ -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 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 this software and associated documentation files (the "Software"), to deal in

2
Octokit.Tests.Conventions/Octokit.Tests.Conventions.csproj
View File

@@ -38,7 +38,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
<PackageReference Include="xunit" Version="2.2.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>
<ItemGroup> <ItemGroup>

2
Octokit.Tests.Conventions/Properties/AssemblyInfo.cs
View File

@@ -10,7 +10,7 @@ using System.Runtime.InteropServices;
[assembly: AssemblyConfiguration("")] [assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")] [assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("Octokit.Tests.Conventions")] [assembly: AssemblyProduct("Octokit.Tests.Conventions")]
[assembly: AssemblyCopyright("Copyright © 2014")] [assembly: AssemblyCopyright("Copyright © 2017")]
[assembly: AssemblyTrademark("")] [assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")] [assembly: AssemblyCulture("")]

2
Octokit.Tests.Integration/Octokit.Tests.Integration.csproj
View File

@@ -36,7 +36,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
<PackageReference Include="xunit" Version="2.2.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>
<ItemGroup> <ItemGroup>

4
Octokit.Tests.Integration/Properties/AssemblyInfo.cs
View File

@@ -9,9 +9,9 @@ using Xunit;
[assembly: AssemblyTitle("Octokit.Tests.Integration")] [assembly: AssemblyTitle("Octokit.Tests.Integration")]
[assembly: AssemblyDescription("")] [assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")] [assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Microsoft")] [assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("Octokit.Tests.Integration")] [assembly: AssemblyProduct("Octokit.Tests.Integration")]
[assembly: AssemblyCopyright("Copyright © Microsoft 2012")] [assembly: AssemblyCopyright("Copyright © 2017")]
[assembly: AssemblyTrademark("")] [assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")] [assembly: AssemblyCulture("")]

2
Octokit.Tests/Octokit.Tests.csproj
View File

@@ -41,7 +41,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
<PackageReference Include="xunit" Version="2.2.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>
<ItemGroup Condition=" '$(TargetFramework)' == 'net452' "> <ItemGroup Condition=" '$(TargetFramework)' == 'net452' ">

4
Octokit.Tests/Properties/AssemblyInfo.cs
View File

@@ -8,9 +8,9 @@ using System.Runtime.InteropServices;
[assembly: AssemblyTitle("Octokit.Tests")] [assembly: AssemblyTitle("Octokit.Tests")]
[assembly: AssemblyDescription("")] [assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")] [assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Microsoft")] [assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("Octokit.Tests")] [assembly: AssemblyProduct("Octokit.Tests")]
[assembly: AssemblyCopyright("Copyright © Microsoft 2012")] [assembly: AssemblyCopyright("Copyright © 2017")]
[assembly: AssemblyTrademark("")] [assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")] [assembly: AssemblyCulture("")]

24
README.md
View File

@@ -26,16 +26,19 @@ Console.WriteLine(user.Followers + " folks love the half ogre!");
## Getting Started ## Getting Started
Octokit is available on NuGet. Octokit is a GitHub API client library for .NET and is available on NuGet:
``` ```
Install-Package Octokit 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 Install-Package Octokit.Reactive
``` ```
### Beta packages ### ### Beta packages ###
Unstable NuGet packages that track the master branch of this repository are available at 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) [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 ## Build
Octokit is a single assembly designed to be easy to deploy anywhere. If you Octokit is a single assembly designed to be easy to deploy anywhere.
prefer to compile it yourself, you’ll need:
* Visual Studio 2015 or Xamarin Studio To clone and build it locally click the "Clone in Desktop" button above or run the
* Windows 8.1 or higher to build and test the WinRT projects
To clone it locally click the "Clone in Desktop" button above or run the
following git commands. following git commands.
``` ```
git clone git@github.com:octokit/Octokit.net.git Octokit git clone git@github.com:octokit/Octokit.net.git Octokit
cd Octokit cd Octokit
.\build.cmd
``` ```
To build the libraries, run the following command:
Windows: `.\build.ps1`
Linux/OSX: `./build.sh`
## Contribute ## Contribute
Visit the [Contributor Guidelines](https://github.com/octokit/octokit.net/blob/master/CONTRIBUTING.md) Visit the [Contributor Guidelines](https://github.com/octokit/octokit.net/blob/master/CONTRIBUTING.md)
@@ -95,6 +99,6 @@ problem.
## Copyright and License ## 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) Licensed under the [MIT License](https://github.com/octokit/octokit.net/blob/master/LICENSE.txt)

2
build/Build.csproj
View File

@@ -6,7 +6,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Cake.Frosting" Version="0.1.0-alpha0059" /> <PackageReference Include="Cake.Frosting" Version="0.1.0-alpha0071" />
</ItemGroup> </ItemGroup>
</Project> </Project>

3
build/Context.cs
View File

@@ -31,8 +31,7 @@ public class Context : FrostingContext
var settings = new DotNetCoreTestSettings var settings = new DotNetCoreTestSettings
{ {
Configuration = Configuration, Configuration = Configuration,
NoBuild = true, NoBuild = true
Verbose = false
}; };
if (!this.IsRunningOnWindows()) if (!this.IsRunningOnWindows())

7
build/Tasks/IntegrationTests.cs
View File

@@ -12,12 +12,7 @@ public sealed class IntegrationTests : FrostingTask<Context>
foreach (var project in context.Projects.Where(x => x.IntegrationTests)) foreach (var project in context.Projects.Where(x => x.IntegrationTests))
{ {
context.Information("Executing Integration Tests Project {0}...", project.Name); context.Information("Executing Integration Tests Project {0}...", project.Name);
context.DotNetCoreTest(project.Path.FullPath, new DotNetCoreTestSettings context.DotNetCoreTest(project.Path.FullPath, context.GetTestSettings());
{
Configuration = context.Configuration,
NoBuild = true,
Verbose = false
});
} }
} }

1
build/Tasks/Package.cs
View File

@@ -20,7 +20,6 @@ public sealed class Package : FrostingTask<Context>
{ {
Configuration = context.Configuration, Configuration = context.Configuration,
NoBuild = true, NoBuild = true,
Verbose = false,
OutputDirectory = context.Artifacts, OutputDirectory = context.Artifacts,
ArgumentCustomization = args => args.Append("/p:Version={0}", context.Version.GetSemanticVersion()) ArgumentCustomization = args => args.Append("/p:Version={0}", context.Version.GetSemanticVersion())
}); });

5
build/Tasks/Restore.cs
View File

@@ -7,9 +7,6 @@ public sealed class Restore : FrostingTask<Context>
{ {
public override void Run(Context context) public override void Run(Context context)
{ {
context.DotNetCoreRestore(".", new DotNetCoreRestoreSettings context.DotNetCoreRestore(".");
{
Verbose = false
});
} }
} }

36
docs/shipping-releases.md
View File

@@ -2,22 +2,23 @@
## Pre-requisites ## Pre-requisites
- Visual Studio 2013 Update 4 - Visual Studio 2017 Update 3
- Debugging Tools for Windows (install via [Chocolatey](http://chocolatey.org) - `cinst windbg`)
### Running Tests ### 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: 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 If you want to avoid these tests, or get faster feedback, the Unit and Convention tests are run in the default target
tests: > `.\build.ps1`
> `.\build UnitTests` Or can be run individually:
> `.\build ConventionTests`
> `.\build.ps1 -Target UnitTests`
> `.\build.ps1 -Target ConventionTests`
### Signing Assemblies ### Signing Assemblies
@@ -25,20 +26,7 @@ tests:
### Create NuGet Packages ### Create NuGet Packages
To generate the NuGet packages, you also need to setup the SourceLink tools. NuGet packages are automatically generated (and SourceLinked) by the CAKE build script.
> `.\build.ps1`
Set this for the repository: The output .nupkg files will be located in the `packaging` directory.
> 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.