From 4a095dc8d1f5e4719c080e545dcc60d4fd8b5f52 Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Thu, 10 Mar 2016 13:36:34 +1100 Subject: [PATCH 1/4] draft release notes --- ReleaseNotes.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/ReleaseNotes.md b/ReleaseNotes.md index 389f41e2..a61a4e9f 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -1,3 +1,47 @@ +### New in 0.19.0 (released 2016/03/11) + +**Features** + + - Add `GetLatest` endpoint for Releases API - #975 via @chenjiaming93 + - Add Enterprise License and Organization APIs - #1073 via @ryangribble + - Add Locked property to `PullRequest` - #1089 via @M-Zuber + - Add Enterprise Search Indexing API - #1095 via @ryangribble + - Add support for `Visibility` and `Affiliation` to repository search - #1096, #1132 via @Sarmad93, @AlexP11223 + - Add Enterprise LDAP API - #1099 via @ryangribble + - Add `CreateBranch` extension methods to IReferencesClient - #1103 via @M-Zuber + - Additional Enterprise methods on User Administration Client - #1108 via @ryangribble + - Complete `UserKeysClient` API - #1112 via @ryangribble + - `RepositoryContentsClient` create, update and delete actions now specify branch - #1093 via @M-Zuber + +**Fixes** + + - `StatisticsClient` should not clobber /api/v3/ in path - #1085 via @shiftkey + - Fix JSON deserialization of string containing hyphens to List property - #1094 via @ryangribble + - Incorrect reference passed to `RepositoryContentsClient.GetArchive` - #1113 via @michael-kokorin + +**Other** + + - Add failing integration test for Issue Search API - #1083 via @hahmed + - Add integration tests for `IReleasesClient.GetLatest` - #1090 via @M-Zuber + - Remove extraneous Bcl .targets reference - #1100 via @shana + - Add proper syntax highlighting to exploring-pull-requests.md - #1117 via @tiesmaster + - Fix issue with optional parameters in .\script\configure-integration-tests - #1118 via @Anubhav10 + - Update Issue creation sample code - #1131 via @AlexP11223 + - `IJsonSerializer` not used inside `Connection` - #1133 via @devkhan + +**Breaking Changes** + +`ISshKeysClient` has a number of methods which at the time should have been +implemented in `IUserKeysClient` - these methods are marked as obsolete and will +be removed in a future release: + + - `ISshKeysClient.Get(int id)` + - `ISshKeysClient.GetAll(string user)` + - `ISshKeysClient.GetAllForCurrent()` + - `ISshKeysClient.Create(SshKeyUpdate key)` + - `ISshKeysClient.Update(int id, SshKeyUpdate key)` + - `ISshKeysClient.Delete(int id)` + ### New in 0.18.0 (released 2016/02/03) * New: support for User Administration API (GitHub Enterprise) - #1068 via @paladique From 60603b70e7a614bb8fb4b21106dc1ec49187434a Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Thu, 10 Mar 2016 13:43:10 +1100 Subject: [PATCH 2/4] version bump --- SolutionInfo.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SolutionInfo.cs b/SolutionInfo.cs index 311d444a..a52961be 100644 --- a/SolutionInfo.cs +++ b/SolutionInfo.cs @@ -3,11 +3,11 @@ using System.Reflection; using System.Runtime.InteropServices; [assembly: AssemblyProductAttribute("Octokit")] -[assembly: AssemblyVersionAttribute("0.18.0")] -[assembly: AssemblyFileVersionAttribute("0.18.0")] +[assembly: AssemblyVersionAttribute("0.19.0")] +[assembly: AssemblyFileVersionAttribute("0.19.0")] [assembly: ComVisibleAttribute(false)] namespace System { internal static class AssemblyVersionInformation { - internal const string Version = "0.18.0"; + internal const string Version = "0.19.0"; } } From a8162c4af065402166b703c246805164548968cd Mon Sep 17 00:00:00 2001 From: Mordechai Zuber Date: Thu, 10 Mar 2016 09:07:35 +0200 Subject: [PATCH 3/4] IUserKeysClient.GetAll -> GetAllForCurrent() --- Octokit.Reactive/Clients/IObservableUserKeysClient.cs | 2 +- Octokit.Reactive/Clients/ObservableUserKeysClient.cs | 4 ++-- Octokit.Tests.Integration/Clients/UserKeysClientTests.cs | 4 ++-- .../Reactive/ObservableUserKeysClientTests.cs | 4 ++-- Octokit.Tests/Clients/UserKeysClientTests.cs | 2 +- Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs | 4 ++-- Octokit/Clients/IUserKeysClient.cs | 2 +- Octokit/Clients/UserKeysClient.cs | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableUserKeysClient.cs b/Octokit.Reactive/Clients/IObservableUserKeysClient.cs index bf196a00..b9ed4392 100644 --- a/Octokit.Reactive/Clients/IObservableUserKeysClient.cs +++ b/Octokit.Reactive/Clients/IObservableUserKeysClient.cs @@ -19,7 +19,7 @@ namespace Octokit.Reactive /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// - IObservable GetAll(); + IObservable GetAllForCurrent(); /// /// Gets all verified public keys for a user. diff --git a/Octokit.Reactive/Clients/ObservableUserKeysClient.cs b/Octokit.Reactive/Clients/ObservableUserKeysClient.cs index 15245375..1b563b94 100644 --- a/Octokit.Reactive/Clients/ObservableUserKeysClient.cs +++ b/Octokit.Reactive/Clients/ObservableUserKeysClient.cs @@ -29,9 +29,9 @@ namespace Octokit.Reactive /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// - public IObservable GetAll() + public IObservable GetAllForCurrent() { - return _client.GetAll().ToObservable().SelectMany(k => k); + return _client.GetAllForCurrent().ToObservable().SelectMany(k => k); } /// diff --git a/Octokit.Tests.Integration/Clients/UserKeysClientTests.cs b/Octokit.Tests.Integration/Clients/UserKeysClientTests.cs index 29d3d90d..8a711206 100644 --- a/Octokit.Tests.Integration/Clients/UserKeysClientTests.cs +++ b/Octokit.Tests.Integration/Clients/UserKeysClientTests.cs @@ -14,7 +14,7 @@ namespace Octokit.Tests.Integration.Clients using (var context = await github.CreatePublicKeyContext()) { - var keys = await github.User.Keys.GetAll(); + var keys = await github.User.Keys.GetAllForCurrent(); Assert.NotEmpty(keys); var first = keys[0]; @@ -72,7 +72,7 @@ namespace Octokit.Tests.Integration.Clients await github.User.Keys.Delete(key.Id); // Verify key no longer exists - var keys = await github.User.Keys.GetAll(); + var keys = await github.User.Keys.GetAllForCurrent(); Assert.False(keys.Any(k => k.Title == keyTitle && k.Key == keyData)); } } diff --git a/Octokit.Tests.Integration/Reactive/ObservableUserKeysClientTests.cs b/Octokit.Tests.Integration/Reactive/ObservableUserKeysClientTests.cs index 4dc15728..cf56317b 100644 --- a/Octokit.Tests.Integration/Reactive/ObservableUserKeysClientTests.cs +++ b/Octokit.Tests.Integration/Reactive/ObservableUserKeysClientTests.cs @@ -21,7 +21,7 @@ namespace Octokit.Tests.Integration.Clients { using (var context = await _github.CreatePublicKeyContext()) { - var observable = _github.User.Keys.GetAll(); + var observable = _github.User.Keys.GetAllForCurrent(); var keys = await (observable.ToList()); Assert.NotEmpty(keys); @@ -80,7 +80,7 @@ namespace Octokit.Tests.Integration.Clients await _github.User.Keys.Delete(key.Id); // Verify key no longer exists - var keys = await (_github.User.Keys.GetAll().ToList()); + var keys = await (_github.User.Keys.GetAllForCurrent().ToList()); Assert.False(keys.Any(k => k.Title == keyTitle && k.Key == keyData)); } } diff --git a/Octokit.Tests/Clients/UserKeysClientTests.cs b/Octokit.Tests/Clients/UserKeysClientTests.cs index 90d60f1d..697fffda 100644 --- a/Octokit.Tests/Clients/UserKeysClientTests.cs +++ b/Octokit.Tests/Clients/UserKeysClientTests.cs @@ -17,7 +17,7 @@ namespace Octokit.Tests.Clients var client = new UserKeysClient(connection); var expectedUri = "user/keys"; - client.GetAll(); + client.GetAllForCurrent(); connection.Received().GetAll( Arg.Is(u => u.ToString() == expectedUri)); diff --git a/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs b/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs index 508e129a..608b7178 100644 --- a/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs +++ b/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs @@ -16,9 +16,9 @@ namespace Octokit.Tests.Reactive var gitHubClient = Substitute.For(); var client = new ObservableUserKeysClient(gitHubClient); - client.GetAll(); + client.GetAllForCurrent(); - gitHubClient.User.Keys.Received().GetAll(); + gitHubClient.User.Keys.Received().GetAllForCurrent(); } } diff --git a/Octokit/Clients/IUserKeysClient.cs b/Octokit/Clients/IUserKeysClient.cs index 226778b6..6334616d 100644 --- a/Octokit/Clients/IUserKeysClient.cs +++ b/Octokit/Clients/IUserKeysClient.cs @@ -19,7 +19,7 @@ namespace Octokit /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// - Task> GetAll(); + Task> GetAllForCurrent(); /// /// Gets all verified public keys for a user. diff --git a/Octokit/Clients/UserKeysClient.cs b/Octokit/Clients/UserKeysClient.cs index 012b32ae..cc8dee50 100644 --- a/Octokit/Clients/UserKeysClient.cs +++ b/Octokit/Clients/UserKeysClient.cs @@ -23,7 +23,7 @@ namespace Octokit /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// - public Task> GetAll() + public Task> GetAllForCurrent() { return ApiConnection.GetAll(ApiUrls.Keys()); } From e041f529547dfd74107ef1caa4cae5e0e18b6c04 Mon Sep 17 00:00:00 2001 From: Mordechai Zuber Date: Thu, 10 Mar 2016 12:02:14 +0200 Subject: [PATCH 4/4] Pedantic all the way --- Octokit.Reactive/Clients/IObservableUserKeysClient.cs | 1 + Octokit.Tests/Clients/UserKeysClientTests.cs | 2 +- Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs | 2 +- Octokit/Clients/IUserKeysClient.cs | 1 + 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableUserKeysClient.cs b/Octokit.Reactive/Clients/IObservableUserKeysClient.cs index b9ed4392..4c5aa927 100644 --- a/Octokit.Reactive/Clients/IObservableUserKeysClient.cs +++ b/Octokit.Reactive/Clients/IObservableUserKeysClient.cs @@ -19,6 +19,7 @@ namespace Octokit.Reactive /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// + [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")] IObservable GetAllForCurrent(); /// diff --git a/Octokit.Tests/Clients/UserKeysClientTests.cs b/Octokit.Tests/Clients/UserKeysClientTests.cs index 697fffda..e36369f0 100644 --- a/Octokit.Tests/Clients/UserKeysClientTests.cs +++ b/Octokit.Tests/Clients/UserKeysClientTests.cs @@ -8,7 +8,7 @@ namespace Octokit.Tests.Clients { public class UserKeysClientTests { - public class TheGetAllMethod + public class TheGetAllForCurrentMethod { [Fact] public void RequestsTheCorrectUrl() diff --git a/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs b/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs index 608b7178..3a569e27 100644 --- a/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs +++ b/Octokit.Tests/Reactive/ObservableUserKeysClientTests.cs @@ -8,7 +8,7 @@ namespace Octokit.Tests.Reactive { public class ObservableUserKeysClientTests { - public class TheGetAllMethod + public class TheGetAllForCurrentMethod { [Fact] public void CallsIntoClient() diff --git a/Octokit/Clients/IUserKeysClient.cs b/Octokit/Clients/IUserKeysClient.cs index 6334616d..41b5a76b 100644 --- a/Octokit/Clients/IUserKeysClient.cs +++ b/Octokit/Clients/IUserKeysClient.cs @@ -19,6 +19,7 @@ namespace Octokit /// https://developer.github.com/v3/users/keys/#list-your-public-keys /// /// + [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")] Task> GetAllForCurrent(); ///