UNPKG

4.82 kBMarkdownView Raw
1# Change Log
2
3## 2.4.0 - 2016/09/16
4### Features
5* add `Issue.createLabel`
6* add `Repository.createKey`
7* add `Repository.deleteKey`
8* add `Repository.getBranch`
9* add `Repository.listKeys`
10* add `Repository.getKey`
11* add `Repository.updatePullRequest`
12* deprecate `Repository.updatePullRequst`
13
14### Fixes
15* Request URL for deleting a hook (`Repository.deleteHook`)
16
17## 2.3.0 - 2016/06/17
18### Features
19* add `Repository.mergePullRequest`
20* add `Repository.updatePullRequest`
21* add `Repository.listPullRequestFiles`
22* add `Repository.getReadme`
23
24## 2.2.0 - 2016/05/27
25### Features
26* add `Issue.listIssueEvents`
27
28### Fixes
29* Search returns results again
30
31## 2.1.0 - 2016/05/26
32### Features
33Team API
34* `Organization.createTeam`
35* `Organization.getTeams`
36* `Team.getTeam`
37* `Team.listRepos`
38* `Team.editTeam`
39* `Team.listMembers`
40* `Team.getMembership`
41* `Team.addMembership`
42* `Team.isManagedRepo`
43* `Team.manageRepo`
44* `Team.unmanageRepo`
45* `Team.deleteTeam`
46
47## 2.0.0
48### Breaking
49* `Repository#move` has a new argument list
50User
51* `getRepos``listRepos`
52* `getOrgs``listOrgs`
53* `getGists``listGists`
54* `getNotifications``listNotifications`
55* `getStarredRepos``listStarredRepos`
56
57### Fixes
58* `Repository`: `move` now works
59* `User`: `listRepos`
60
61## 1.2.1
62### Fixes
63* `Repository`: Replace invalid references to `postTree` with `createTree`
64
65## 1.2.0 - 2016/05/11
66### Features
67* Search API now returns all pages of results
68* Added `Repository.listReleases`
69
70Added functions for querying organization membership
71* `Organization.listMembers`
72* `Organization.isMember`
73
74Added functions for issue comments
75* `Issue.listComments`
76* `Issue.getComment`
77* `Issue.editComment`
78* `Issue.deleteComment`
79
80### Fixes
81* all functions now return a Promise
82
83## 1.1.0 - 2016/05/03
84### Features
85Added methods for commenting on Gists:
86* `Gist.listComments`
87* `Gist.getComment`
88* `Gist.editComment`
89* `Gist.deleteComment`
90* `Gist.createComment`
91
92### Fixes
93* `Repository.deleteFile` now correctly returns a promise.
94
95## 1.0.0 - 2016/04/27
96Complete rewrite in ES2015.
97
98* Promise-ified the API
99* Auto-generation of documentation
100* Modularized codebase
101* Refactored tests to run primarily in mocha
102
103### Breaking changes
104Most of the breaking changes are just methods that got renamed. The changes to `User` and `Organization` are deeper
105changes that now scope a particular `User` or `Organization` to the entity they were instantiated with. You will need
106separate `User`s to query data about different user accounts.
107
108* `Github.getOrg``Github.getOrganization` and requires an organization name.
109* `Github.getUser` now requires a username.
110* `Issue.comment``Issue.createIssueComment`
111* `Issue.create``Issue.createIssue`
112* `Issue.edit``Issue.editIssue`
113* `Issue.get``Issue.getIssue`
114* `Issue.list``Issue.listIssues`
115* `Repository.branch``Repository.createBranch`
116* `Repository.collaborators``Repository.getCollaborators`
117* `Repository.compare``Repository.compareBranches`
118* `Repository.contents``Repository.getContents` and now takes an argument for the content type
119* `Repository.delete` has been removed.
120* `Repository.editHook``Repository.updateHook`
121* `Repository.editRelease``Repository.updateRelease`
122* `Repository.getCommit` no longer takes a branch as the first argument
123* `Repository.getPull``Repository.getPullRequest`
124* `Repository.getRef` now returns the `refspec` from GitHub's API.
125* `Repository.getSha` now returns the same data as GitHub's API. If the reqeusted object is not a directory then the
126 response will contain a property `SHA`, and if the reqeusted object is a directory then the contents of the directory
127 are `stat`ed.
128* `Repository.getStatuses``Repository.listStatuses`
129* `Repository.listPulls``Repository.listPullRequests`
130* `Repository.postBlob``Repository.createBlob`
131* `Repository.postTree``Repository.createTree`
132* `Repository.read` remove in favor of `Repository.getContents`
133* `Repository.remove``Repository.deleteFile`
134* `Repository.show``Repository.getDetails`
135* `Repository.write``Repository.writeFile`
136* `Search.code``Search.forCode`
137* `Search.issues``Search.forIssues`
138* `Search.repositories``Search.forRepositories`
139* `Search.users``Search.forUsers`
140* The Search API no longer takes a string, it now takes an object with properties `q`, `sort`, and `order` to make the
141 parts of the query easier to grok and to better match GitHub's API.
142* `User.gists``User.getGists`
143* `User.notifications``User.getNotifications`
144* `User.orgRepos``Organization.getRepos`
145* `User.orgs``User.getOrgs`
146* `User.repos``User.getRepos`
147* `User.show``User.getProfile` and no longer takes filtering options
148* `User.userStarred``User.getStarredRepos`