mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
Release v0.25 - She'll be Comin' Round the Mountain (#1656)
* Run `build -Target FormatCode` to fixup whitespace etc * Fix delete release asset integration test * Fix repository fork test * Fix pagination test for PR Review Request * First cut of release notes * update release notes * Update release notes * include links to contributors * Add breaking changes/advisories section * Tidy up formatting * Tidy up wording
This commit is contained in:
@@ -107,7 +107,7 @@ public class PullRequestReviewRequestsClientTests
|
||||
var options = new ApiOptions
|
||||
{
|
||||
PageSize = 1,
|
||||
PageCount = 2,
|
||||
PageCount = 1,
|
||||
StartPage = 2
|
||||
};
|
||||
var reviewRequests = await _client.GetAll(_context.RepositoryId, number, options);
|
||||
|
||||
@@ -788,7 +788,7 @@ public class ReleasesClientTests
|
||||
|
||||
await _releaseClient.DeleteAsset(_context.RepositoryOwner, _context.RepositoryName, result.Id);
|
||||
|
||||
await Assert.ThrowsAsync<NotFoundException>(async () => await _releaseClient.DeleteAsset(_context.RepositoryOwner, _context.RepositoryName, result.Id));
|
||||
await Assert.ThrowsAsync<NotFoundException>(async () => await _releaseClient.GetAsset(_context.RepositoryOwner, _context.RepositoryName, result.Id));
|
||||
}
|
||||
|
||||
[IntegrationTest]
|
||||
@@ -806,7 +806,9 @@ public class ReleasesClientTests
|
||||
|
||||
Assert.NotNull(asset);
|
||||
|
||||
await Assert.ThrowsAsync<NotFoundException>(async () => await _releaseClient.DeleteAsset(_context.Repository.Id, result.Id));
|
||||
await _releaseClient.DeleteAsset(_context.Repository.Id, result.Id);
|
||||
|
||||
await Assert.ThrowsAsync<NotFoundException>(async () => await _releaseClient.GetAsset(_context.Repository.Id, result.Id));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -700,9 +700,9 @@ public class RepositoriesClientTests
|
||||
{
|
||||
var github = Helper.GetAuthenticatedClient();
|
||||
|
||||
var repository = await github.Repository.Get("haacked", "libgit2sharp");
|
||||
var repository = await github.Repository.Get("octokitnet-test1", "octokit.net");
|
||||
|
||||
Assert.Equal("https://github.com/Haacked/libgit2sharp.git", repository.CloneUrl);
|
||||
Assert.Equal("https://github.com/octokitnet-test1/octokit.net.git", repository.CloneUrl);
|
||||
Assert.True(repository.Fork);
|
||||
}
|
||||
|
||||
@@ -711,9 +711,9 @@ public class RepositoriesClientTests
|
||||
{
|
||||
var github = Helper.GetAuthenticatedClient();
|
||||
|
||||
var repository = await github.Repository.Get(4550038);
|
||||
var repository = await github.Repository.Get(100559458);
|
||||
|
||||
Assert.Equal("https://github.com/Haacked/libgit2sharp.git", repository.CloneUrl);
|
||||
Assert.Equal("https://github.com/octokitnet-test1/octokit.net.git", repository.CloneUrl);
|
||||
Assert.True(repository.Fork);
|
||||
}
|
||||
|
||||
|
||||
@@ -141,7 +141,6 @@ public class ObservableRepositoryCollaboratorClientTests
|
||||
}
|
||||
public class TheReviewPermissionMethod
|
||||
{
|
||||
|
||||
[IntegrationTest]
|
||||
public async Task ReturnsReadPermissionForNonCollaborator()
|
||||
{
|
||||
|
||||
@@ -257,7 +257,6 @@ public class PullRequestReviewsClientTests
|
||||
[Fact]
|
||||
public async Task PostsToCorrectUrlWithRepositoryId()
|
||||
{
|
||||
|
||||
var connection = Substitute.For<IApiConnection>();
|
||||
var client = new PullRequestReviewsClient(connection);
|
||||
|
||||
@@ -285,7 +284,6 @@ public class PullRequestReviewsClientTests
|
||||
[Fact]
|
||||
public async Task PostsToCorrectUrl()
|
||||
{
|
||||
|
||||
var connection = Substitute.For<IApiConnection>();
|
||||
var client = new PullRequestReviewsClient(connection);
|
||||
|
||||
@@ -301,7 +299,6 @@ public class PullRequestReviewsClientTests
|
||||
[Fact]
|
||||
public async Task PostsToCorrectUrlWithRepositoryId()
|
||||
{
|
||||
|
||||
var connection = Substitute.For<IApiConnection>();
|
||||
var client = new PullRequestReviewsClient(connection);
|
||||
|
||||
|
||||
@@ -233,7 +233,6 @@ namespace Octokit.Tests.Clients
|
||||
await Assert.ThrowsAsync<ArgumentNullException>(() => client.ReviewPermission(1L, null));
|
||||
await Assert.ThrowsAsync<ArgumentException>(() => client.ReviewPermission(1L, ""));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public class TheAddMethod
|
||||
|
||||
@@ -91,7 +91,6 @@ namespace Octokit.Tests.Reactive
|
||||
[Fact]
|
||||
public async Task RequestsCorrectUrlMulti()
|
||||
{
|
||||
|
||||
var firstPageUrl = new Uri("repos/owner/name/pulls/7/reviews", UriKind.Relative);
|
||||
var secondPageUrl = new Uri("https://example.com/page/2");
|
||||
var firstPageLinks = new Dictionary<string, Uri> { { "next", secondPageUrl } };
|
||||
@@ -219,7 +218,6 @@ namespace Octokit.Tests.Reactive
|
||||
|
||||
Assert.Throws<ArgumentException>(() => client.GetAll("", "name", 1, ApiOptions.None));
|
||||
Assert.Throws<ArgumentException>(() => client.GetAll("owner", "", 1, ApiOptions.None));
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -615,7 +613,6 @@ namespace Octokit.Tests.Reactive
|
||||
|
||||
Assert.Throws<ArgumentException>(() => client.GetAllComments("", "name", 1, 1, ApiOptions.None));
|
||||
Assert.Throws<ArgumentException>(() => client.GetAllComments("owner", "", 1, 1, ApiOptions.None));
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -12,7 +12,6 @@ namespace Octokit
|
||||
/// </remarks>
|
||||
public interface IProjectCardsClient
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Gets all cards.
|
||||
/// </summary>
|
||||
|
||||
@@ -536,7 +536,6 @@ namespace Octokit
|
||||
Ensure.ArgumentNotNullOrEmptyString(branch, "branch");
|
||||
|
||||
return ApiConnection.Get<EnforceAdmins>(ApiUrls.RepoProtectedBranchAdminEnforcement(repositoryId, branch), null, AcceptHeaders.ProtectedBranchesApiPreview);
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -48,6 +48,5 @@ namespace Octokit
|
||||
public const string ProjectsApiPreview = "application/vnd.github.inertia-preview+json";
|
||||
|
||||
public const string OrganizationMembershipPreview = "application/vnd.github.korra-preview+json";
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,7 +12,6 @@ namespace Octokit
|
||||
[DebuggerDisplay("{DebuggerDisplay,nq}")]
|
||||
public class RepositoryUpdate
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Creates an object that describes an update to a repository on GitHub.
|
||||
/// </summary>
|
||||
|
||||
@@ -1,3 +1,78 @@
|
||||
### New in 0.25.0 (released 23/8/2017)
|
||||
|
||||
## Advisories and Breaking Changes
|
||||
|
||||
- Octokit.net has been ported to dotnetcore :tada: providing libraries targetting `netstandard1.1` and `net45` frameworks
|
||||
|
||||
- `Enum` fields in Octokit response classes are now wrapped in an `StringEnum<TEnum>` helper class, to provide more robustness in dealing with unknown API values for these fields. Whilst the changes are backwards compatible, please consult the guidance on [working with Enums](https://github.com/octokit/octokit.net/blob/master/docs/working-with-enums.md) for more information
|
||||
|
||||
- `IncludeAdmins` field is no longer present in `BranchProtectionRequiredStatusChecks` and `BranchProtectionRequiredStatusChecksUpdate` classes, instead use the new `EnforceAdmins` field on `BranchProtectionSettingsUpdate` or the [new explicit methods](https://github.com/octokit/octokit.net/blob/master/Octokit/Clients/IRepositoryBranchesClient.cs#L304-L365) for configuring Admin Enforcement on protected branches. This was an [upstream API breaking change](https://developer.github.com/changes/2017-05-02-adoption-of-admin-enforced/) so we couldn't follow our normal deprecation schedule
|
||||
|
||||
## Release Notes
|
||||
|
||||
### Milestone: CAKE Builds
|
||||
|
||||
**Features/Enhancements**
|
||||
|
||||
- Add a build task to validate LINQPad samples - [#1551](https://github.com/octokit/octokit.net/pull/1551) via [@mderriey](https://github.com/mderriey)
|
||||
- Add a code formatting task to CAKE - [#1550](https://github.com/octokit/octokit.net/pull/1550) via [@mderriey](https://github.com/mderriey)
|
||||
- Add GitVersion configuration file - [#1555](https://github.com/octokit/octokit.net/pull/1555) via [@mderriey](https://github.com/mderriey)
|
||||
|
||||
|
||||
### Milestone: dotnetcore Support
|
||||
|
||||
**Features/Enhancements**
|
||||
|
||||
- Port to .NET Core - [#1503](https://github.com/octokit/octokit.net/pull/1503) via [@mderriey](https://github.com/mderriey), [@ryangribble](https://github.com/ryangribble)
|
||||
- Remove unneeded files for .NET Core - [#1549](https://github.com/octokit/octokit.net/pull/1549) via [@mderriey](https://github.com/mderriey)
|
||||
- Migrate dotnetcore to vs2017 tooling - [#1567](https://github.com/octokit/octokit.net/pull/1567) via [@ryangribble](https://github.com/ryangribble), [@mderriey](https://github.com/mderriey)
|
||||
- Provide [SourceLink](https://github.com/ctaggart/SourceLink) capability for Octokit and Octokit.Reactive assemblies - [#1574](https://github.com/octokit/octokit.net/pull/1574) via [@ryangribble](https://github.com/ryangribble), [@mderriey](https://github.com/mderriey)
|
||||
- Deliver the dotnetcore port and CAKE build framework changes - [#1581](https://github.com/octokit/octokit.net/pull/1581) via [@ryangribble](https://github.com/ryangribble), [@mderriey](https://github.com/mderriey)
|
||||
|
||||
**Fixes**
|
||||
|
||||
- Fix broken JSON deserialization in .NET 4.5 after VS2017 project update - [#1647](https://github.com/octokit/octokit.net/pull/1647) via [@mderriey](https://github.com/mderriey)
|
||||
|
||||
|
||||
### Milestone: None
|
||||
|
||||
**Features/Enhancements**
|
||||
|
||||
- Add support for the newly resurrected `PullRequest.MergeCommitSha` property - [#1562](https://github.com/octokit/octokit.net/pull/1562) via [@alexperovich](https://github.com/alexperovich)
|
||||
- Enhance `RepositoryBranchesClient` to support Admin Enforcement changes - [#1598](https://github.com/octokit/octokit.net/pull/1598) via [@M-Zuber](https://github.com/M-Zuber)
|
||||
- Implement [Pull Request Review Requests API (Preview)](https://developer.github.com/v3/pulls/review_requests/) - [#1588](https://github.com/octokit/octokit.net/pull/1588) via [@gdziadkiewicz](https://github.com/gdziadkiewicz), [@ryangribble](https://github.com/ryangribble)
|
||||
- Provide a robust way to handle unknown enum values returned by GitHub API, to prevent deserialization errors until the enum values can be added to octokit - [#1595](https://github.com/octokit/octokit.net/pull/1595) via [@khellang](https://github.com/khellang), [@ryangribble](https://github.com/ryangribble)
|
||||
- Implement [Projects API (Preview)](https://developer.github.com/v3/projects/) - [#1480](https://github.com/octokit/octokit.net/pull/1480) via [@maddin2016](https://github.com/maddin2016), [@ryangribble](https://github.com/ryangribble)
|
||||
- Implement `ReviewPermission()` functionality for `OrganizationMembersClient` (Preview API) - [#1633](https://github.com/octokit/octokit.net/pull/1633) via [@alfhenrik](https://github.com/alfhenrik)
|
||||
- Implement [Organization OutsideCollaborators API (Preview)](https://developer.github.com/v3/orgs/outside_collaborators/) - [#1639](https://github.com/octokit/octokit.net/pull/1639) via [@alfhenrik](https://github.com/alfhenrik), [@ryangribble](https://github.com/ryangribble)
|
||||
- Implement pagination support for `OrganizationOutsideCollaboratorsClient.GetAll()` method - [#1650](https://github.com/octokit/octokit.net/pull/1650) via [@ryangribble](https://github.com/ryangribble)
|
||||
- Implement `GetAllPendingInvitations()` functionality for `OrganizationMembersClient` and `TeamsClient` (Preview API) - [#1640](https://github.com/octokit/octokit.net/pull/1640) via [@alfhenrik](https://github.com/alfhenrik), [@ryangribble](https://github.com/ryangribble)
|
||||
- Implement [Pull Request Reviews API](https://developer.github.com/v3/pulls/reviews/) - [#1648](https://github.com/octokit/octokit.net/pull/1648) via [@hartra344](https://github.com/hartra344), [@ryangribble](https://github.com/ryangribble)
|
||||
|
||||
**Fixes**
|
||||
|
||||
- Fix `RepositoryTrafficClient` to handle upstream API change in timestamps from Unix epoch time to ISO8601 - [#1560](https://github.com/octokit/octokit.net/pull/1560) via [@mderriey](https://github.com/mderriey), [@ryangribble](https://github.com/ryangribble)
|
||||
- Fix more `IssueTimelineClient` deserialization exceptions by adding more new `EventInfoState` values - [#1563](https://github.com/octokit/octokit.net/pull/1563) via [@ryangribble](https://github.com/ryangribble)
|
||||
- Fix `NotificationsClient.MarkAsRead()` exception by specifying a payload body in the `PUT` request - [#1579](https://github.com/octokit/octokit.net/pull/1579) via [@shiftkey](https://github.com/shiftkey), [@ryangribble](https://github.com/ryangribble)
|
||||
- Fix `connection.GetLastApiInfo()` was returning `null` in some situations - [#1580](https://github.com/octokit/octokit.net/pull/1580) via [@ryangribble](https://github.com/ryangribble)
|
||||
- Fix even more `IssueTimelineClient` deserialization exceptions by adding even more new `EventInfoState` values (this is getting old!) - [#1591](https://github.com/octokit/octokit.net/pull/1591) via [@lynnfaraday](https://github.com/lynnfaraday), [@ryangribble](https://github.com/ryangribble)
|
||||
- `NewRepositoryWebHook.ToRequest()` no longer discards existing fields if they are set - [#1623](https://github.com/octokit/octokit.net/pull/1623) via [@ctolkien](https://github.com/ctolkien)
|
||||
- Fix pagination on API calls that use `Uri` parameters (typically for requests that include some form of filtering) - [#1649](https://github.com/octokit/octokit.net/pull/1649) via [@ryangribble](https://github.com/ryangribble)
|
||||
- Fixed `RepositoryCommitsClient.GetSha1()` to correctly obtain the sha1 of the specified commit, after the API went from preview to official - [#1654](https://github.com/octokit/octokit.net/pull/1654) via [@ryangribble](https://github.com/ryangribble)
|
||||
|
||||
**Housekeeping**
|
||||
|
||||
- Remove obsolete constructor of `RepositoryUpdate` request class - [#1569](https://github.com/octokit/octokit.net/pull/1569) via [@eriawan](https://github.com/eriawan)
|
||||
- Remove unused Rx-Main dependency from LINQPad samples - [#1593](https://github.com/octokit/octokit.net/pull/1593) via [@NickCraver](https://github.com/NickCraver)
|
||||
- Change response models 'Url' properties from `Uri` to `string` - [#1585](https://github.com/octokit/octokit.net/pull/1585) via [@mderriey](https://github.com/mderriey)
|
||||
- Remove obsolete branch protection methods/classes - [#1620](https://github.com/octokit/octokit.net/pull/1620) via [@ryangribble](https://github.com/ryangribble)
|
||||
- Remove methods and members that were marked `[Obsolete]` in 0.23 or earlier - [#1622](https://github.com/octokit/octokit.net/pull/1622) via [@ryangribble](https://github.com/ryangribble)
|
||||
|
||||
**Documentation Updates**
|
||||
|
||||
- Fix `Issue` documentation samples (`GetForRepository()` should be `GetForRepository()`) - [#1602](https://github.com/octokit/octokit.net/pull/1602) via [@tnaoto](https://github.com/tnaoto)
|
||||
- Fix `Release` documentation samples (`ReleaseUpdate` should be `NewRelease`) - [#1611](https://github.com/octokit/octokit.net/pull/1611) via [@watsonlu](https://github.com/watsonlu)
|
||||
|
||||
### New in 0.24.0 (released 17/1/2017)
|
||||
|
||||
**Features/Enhancements**
|
||||
|
||||
Reference in New Issue
Block a user