zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-05 03:30:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

first pass at release notes

Browse Source
This commit is contained in:
Brendan Forster
2016-02-02 13:33:24 +10:30
parent b3dbf74254
commit ceaf09e520
1 changed files with 65 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ReleaseNotes.md
+65 -7
View File
@@ -1,11 +1,69 @@
### New in 0.18.0 (released 2016/01/31)
TODO
* New: support for User Administration API (GitHub Enterprise) - #1068 via @paladique
* New: support for Admin Stats API (GitHub Enterprise) - - #1049 via @ryangribble
* New: support for Repository Pages API - #1061 via @M-Zuber
* New: get stargazer creation timestamps - #1060 via @daveaglick
* New: support for Protected Branches API - #996 via @ryangribble
* New: support for creating Personal Access Tokens - #990 via @alfhenrik
* Fixed: `Milestone` property added to `PullRequest` response - #1075 via @Eilon
* Fixed: Add member role filter to `OrganizationMembersClient.GetAll()` - #1072 via @ryangribble
* Fixed: `Repository.Content.GetAllContents` now support the root of the repository - #1064 via @naveensrinivasan, @shiftkey
* Fixed: added `Id` and `Locked` to `Issue`, added `CommitUrl` to `IssueEvent` - #1039 via @gabrielweyer
* Fixed: additional fields on `Release` and `ReleaseAsset` - #1009 via @gabrielweyer
* Fixed: `ApiException` now includes JSON payload when `.ToString()`- #974 via @asizikov
**Breaking Changes:**
- `IRepositoryContentsClient.GetAllContents(string owner, string name, string path, string reference)` has been renamed to `GetAllContentsByRef(string owner, string name, string path, string reference)`
to prevent overlap with methods on `IRepositoryContentsClient` which do not specify a path - and thus look at the root of the repository.
As part of reaching 1.0 we went through to audit the current implementation
and identify areas that didn't align with our conventions. For this release,
we're marking the endpoints as `[Obsolete]` and indicating the new location.
These will be cleaned up in the next release:
- `IGitHubClient.Notifications` -> `IGitHubClient.Activity.Notifications` - #1019 via @M-Zuber
- `IGitHubClient.Repository.CommitStatus` -> `IGitHubClient.Repository.Status` - #1043 via @RobPethick
- `IGitHubClient.Repository.Commits` -> `IGitHubClient.Repository.Commit` - #1057 via @M-Zuber
- `IGitHubClient.Repository.RepoCollaborators` -> `IGitHubClient.Repository.Collaborator` - #1040 via @M-Zuber
- `IGitHubClient.Repository.RepositoryComments` -> `IGitHubClient.Repository.Comment` - #1044 via @M-Zuber
- `IGitHubClient.Release` -> `IGitHubClient.Repository.Release` - #1058 via @RobPethick
- `IGitHubClient.GitDatabase` -> `IGitHubClient.Git` - #1048 via @RobPethick
Other breaking changes:
- a public `ApiExtensions.Get<T>` extension method was causing a bunch of
tests to be written in a confusing way. This has been ported to an interface
method on `IApiConnection` but hopefully you're not referencing this method
externally - see #1063 for more information.
- `IRepositoryContentsClient.GetArchiveLink` is no longer correct, as the HTTP
behaviour in Octokit was updated to follow redirects received from the server.
See #986 for the last bits of cleanup.
- `IRepositoryContentsClient.GetAllContents(string owner, string name, string path, string reference)`
has been renamed to `GetAllContentsByRef(string owner, string name, string path, string reference)`
to prevent overlap with methods on `IRepositoryContentsClient` which do not
specify a path - and thus look at the root of the repository.
- `IssueEventPayload` has two fields which are never populated from the API -
`Assignee` and `Label` - these are now removed. You should use
`Issue.Assignee` and `Issue.Labels` instead. See #1039 for more details.
- `PullRequest.MergeCommitSha` is marked as obsolete by the GitHub API - we
we used #997 to clean up the behaviour for determining whether a PR has
been merged - see the PR for more information
**Shout outs**
A lot of extra work went into this release, and I wanted to thank those people
who helped out - without their efforts we wouldn't be at this point:
- @naveensrinivasan - for helping set up our Travis CI builds to test this on
Mono - see #995 for the details
- @hahmed - for contributing a bunch of documentation around the Octokit search
APIs - see #955, #954 and #951
- @JakesCode - for clarifying some documentation after he reported an issue - #1054
- @ryangribble - for helping get our GitHub Enterprise testing off the ground - #987
- @naveensrinivasan - for catching and addressing an issue with our Linqpad snippets - #987
### New in 0.17.0 (released 2015/12/07)
@@ -78,7 +136,7 @@ TODO
### New in 0.11.0 (released 2015/05/10)
* New: Added overload to `IRepositoryClient.GetAllPublic` specifying a `since` parameter - #774 via @alfhenrik
* New: Added `IGistsClient.GetAllCommits` and `IGistsClient.GetAllForks` implementations - #542 via @haagenson, #794 via @shiftkey
* New: Added `IRepositoryContentsClient.GetArchiveLink` for getting archived code - #765 via @alfhenrik
* New: Added `IRepositoryContentsClient.GetArchiveLink` for getting archived code - #765 via @alfhenrik
* Fixed: `PullRequestFile` properties were not serialized correctly - #789 via @thedillonb
* Fixed: Allow to download zip-attachments - #792 via @csware
@@ -88,7 +146,7 @@ TODO
**Breaking Changes:**
- As part of #771 there were many method which were returning collections
but the method name made it unclear. You might think that it wasn't much, but
but the method name made it unclear. You might think that it wasn't much, but
you'd be wrong. So if you have a method that no longer compile,
it is likely that you need to set the prefix to `GetAll` to re-disocver that API.
- `CommitComment.Position` is now a nullable `int` to prevent serialization issues.
@@ -244,8 +302,8 @@ TODO
* Fix readonly deserialization bug in NetCore45 and related projects - #455 via @nigel-sampson
### New in 0.3.1 (Released 2014/03/31)
* Add support for comparing two commits - #428 via @shiftkey
* Fix regression in throwing proper 2FA exception - #437 via @Haacked
* Add support for comparing two commits - #428 via @shiftkey
* Fix regression in throwing proper 2FA exception - #437 via @Haacked
### New in 0.3.0 (Released 2014/03/19)
* Add Portable Class Library support for Octokit package - #401 via @trsneed