mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
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
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -10,7 +10,7 @@ using System.Runtime.InteropServices;
|
||||
[assembly: AssemblyConfiguration("")]
|
||||
[assembly: AssemblyCompany("")]
|
||||
[assembly: AssemblyProduct("Octokit.Tests.Conventions")]
|
||||
[assembly: AssemblyCopyright("Copyright © 2014")]
|
||||
[assembly: AssemblyCopyright("Copyright © 2017")]
|
||||
[assembly: AssemblyTrademark("")]
|
||||
[assembly: AssemblyCulture("")]
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -9,9 +9,9 @@ using Xunit;
|
||||
[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("")]
|
||||
|
||||
|
||||
@@ -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' ">
|
||||
|
||||
@@ -8,9 +8,9 @@ using System.Runtime.InteropServices;
|
||||
[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("")]
|
||||
|
||||
|
||||
24
README.md
24
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:
|
||||
Octokit is a single assembly designed to be easy to deploy anywhere.
|
||||
|
||||
* Visual Studio 2015 or Xamarin Studio
|
||||
* 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
|
||||
To clone and build it locally click the "Clone in Desktop" button above or run the
|
||||
following git commands.
|
||||
|
||||
```
|
||||
git clone git@github.com: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)
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -31,8 +31,7 @@ public class Context : FrostingContext
|
||||
var settings = new DotNetCoreTestSettings
|
||||
{
|
||||
Configuration = Configuration,
|
||||
NoBuild = true,
|
||||
Verbose = false
|
||||
NoBuild = true
|
||||
};
|
||||
|
||||
if (!this.IsRunningOnWindows())
|
||||
|
||||
@@ -12,12 +12,7 @@ public sealed class IntegrationTests : FrostingTask<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());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -20,7 +20,6 @@ public sealed class Package : FrostingTask<Context>
|
||||
{
|
||||
Configuration = context.Configuration,
|
||||
NoBuild = true,
|
||||
Verbose = false,
|
||||
OutputDirectory = context.Artifacts,
|
||||
ArgumentCustomization = args => args.Append("/p:Version={0}", context.Version.GetSemanticVersion())
|
||||
});
|
||||
|
||||
@@ -7,9 +7,6 @@ public sealed class Restore : FrostingTask<Context>
|
||||
{
|
||||
public override void Run(Context context)
|
||||
{
|
||||
context.DotNetCoreRestore(".", new DotNetCoreRestoreSettings
|
||||
{
|
||||
Verbose = false
|
||||
});
|
||||
context.DotNetCoreRestore(".");
|
||||
}
|
||||
}
|
||||
@@ -2,22 +2,23 @@
|
||||
|
||||
## 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
|
||||
|
||||
@@ -25,20 +26,7 @@ tests:
|
||||
|
||||
### 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:
|
||||
|
||||
> 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.
|
||||
The output .nupkg files will be located in the `packaging` directory.
|
||||
|
||||
Reference in New Issue
Block a user