octokit/rest.js
### [`v14.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v14.0.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v13.1.1...v14.0.0)
##### Breaking changes
##### The package has been renamed from `github` to `@octokit/rest`.
To upgrade
1. `npm install @octokit/rest`
2. `npm uninstall github`
3. replace `require('github')` with `require('@octokit/rest')`
That’s it, there are no functional changes in the public APIs compared to `github@13`.
##### Debug logs
`DEBUG=node-github*` is now `DEBUG=octokit*`.
In case you enabled debug logs, make sure to adapt the `DEBUG` environment variable accordingly.
### [`v13.1.1`](https://togithub.com/octokit/rest.js/releases/tag/v13.1.1)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v13.1.0...v13.1.1)
##### Bug Fixes
- **typescript:** improve default response type ([#683](https://togithub.com/octokit/node-github/issues/683)) ([ac39fb5](https://togithub.com/octokit/node-github/commit/ac39fb5))
### [`v13.1.0`](https://togithub.com/octokit/rest.js/releases/tag/v13.1.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.2...v13.1.0)
##### Features
- error on 304s ([#673](https://togithub.com/octokit/node-github/issues/673)) ([a0c65a2](https://togithub.com/octokit/node-github/commit/a0c65a2))
### [`v13.0.2`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.2)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.1...v13.0.2)
##### Bug Fixes
- uploadAsset with `file: fs.createReadStream()` ([85255a1](https://togithub.com/octokit/node-github/commit/85255a1))
### [`v13.0.1`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.1)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.0...v13.0.1)
##### Bug Fixes
- respect NO_PROXY environment variable ([#667](https://togithub.com/octokit/node-github/issues/667)) ([9c68105](https://togithub.com/octokit/node-github/commits/9c68105))
### [`v13.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.1.0...v13.0.0)
##### BREAKING CHANGES
- `.get{Scope name}Api()` methods have been removed.
Before you could do this
```js
const reposApi = github.getReposApi()
```
Which is the same as doing
```js
const reposApi = github.repos
```
So we removed it :)
- Before a link header could be passed directly to pagination methods like `github.hasPreviousPage(linkHeaderValue)`. This was never documented and is not being used internally, so we decided to remove the functionality to simplify the code
- The `debug` option for the GitHub Client constructor
has been removed. Set `DEBUG=node-github:*` environment variable instead
- The current implementation has the upload URL hard coded, while the specification says that it has to be received from the Release API endpoint:
https://developer.github.com/v3/repos/releases/#upload-a-release-asset
The new implementation also requires `contentType` as well as `contentLength`. The latter is not documented, but is required. The `filePath` option has been replaced with a `file` option which can be either a read stream, a buffer or a string.
Altogether, uploading an asset before worked like this:
```js
github.repos.getReleaseByTag({
owner: "octokit-fixture-org",
repo: "release-assets",
tag: "v1.0.0"
})
.then(result => {
return github.repos.uploadAsset({
owner: "octokit-fixture-org",
repo: "release-assets",
id: result.data.id,
filePath: pathResolve(__dirname, "test-upload.txt"),
name: "test-upload.txt",
label: "test"
})
})
```
Now it looks like this
```js
github.repos.getReleaseByTag({
owner: "octokit-fixture-org",
repo: "release-assets",
tag: "v1.0.0"
})
.then(result => {
return github.repos.uploadAsset({
url: result.data.upload_url,
file: "Hello, world!\n",
contentType: "text/plain",
contentLength: 14,
name: "test-upload.txt",
label: "test"
})
})
```
If you prefer a higher-level release asset upload library, have a look at https://github.com/gr2m/octokit-release-asset-upload
- the `followRedirects` option has been removed. Previous problems with non-GET redirects should be handled correctly now, the method is always forwarded as all redirects remain within the same host
- Authentication with `"netrc"` is no longer supported:
```js
github.authenticate({
type: "netrc"
})
```
Instead, use the [netrc](https://www.npmjs.com/package/netrc) package directly and pass username/password to `"basic"` authentication
```js
const netrc = require('netrc')
const myNetrc = netrc()
github.authenticate({
type: 'basic',
username: myNetrc['api.github.com'].login,
password: myNetrc['api.github.com'].password
})
```
- passing a custom `Promise` option to the constructor is no longer supported
All suppertod Node versions (4, 6 and 8) have Promise support built in now. So migrating should be as simple as removing the `Promise` option altogether.
##### Features
- always follow redirects ([61e7a81](git+https:github.com/octokit/node-github/commits/61e7a81))
##### Bug Fixes
- no headers are sent if there are no headers ([51eeb0d](git+https:github.com/octokit/node-github/commits/51eeb0d))
### [`v12.1.0`](https://togithub.com/octokit/rest.js/releases/tag/v12.1.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.7...v12.1.0)
##### Features
- add child team list route ([#664](https://togithub.com/octokit/node-github/issues/664)) ([14f18c2](https://togithub.com/octokit/node-github/commit/14f18c2))
### [`v12.0.7`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.7)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.6...v12.0.7)
##### Bug Fixes
- whitelist X-GitHub-SSO header in response ([#663](https://togithub.com/octokit/node-github/issues/663)) ([1e07daf](https://togithub.com/octokit/node-github/commit/1e07daf))
### [`v12.0.6`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.6)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.5...v12.0.6)
##### Bug Fixes
- calculate content-length correctly for raw markdown request ([4f819ad](https://togithub.com/octokit/node-github/commit/4f819ad))
### [`v12.0.5`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.5)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.4...v12.0.5)
##### Bug Fixes
- don’t pass `filePath` as query parameter ([3c2e465](https://togithub.com/octokit/node-github/commit/3c2e465))
### [`v12.0.4`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.4)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.3...v12.0.4)
##### Bug Fixes
- **package:** update follow-redirects to version 1.2.6 ([1667120](https://togithub.com/octokit/node-github/commit/1667120))
### [`v12.0.3`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.3)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.2...v12.0.3)
##### Bug Fixes
- routes.json validation for project cards and columns ([072a53f](https://togithub.com/octokit/node-github/commit/072a53f))
### [`v12.0.2`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.2)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.1...v12.0.2)
##### Bug Fixes
- TypeScript/Flow definitions ([be1d098](https://togithub.com/octokit/node-github/commit/be1d098))
### [`v12.0.1`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.1)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.0...v12.0.1)
##### Bug Fixes
- adapt for mime@2 ([fb0ad88](https://togithub.com/octokit/node-github/commit/fb0ad88))
### [`v12.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v11.0.0...v12.0.0)
##### Bug Fixes
- remove trailing slash from `/repos/:owner/:repo/git/refs/` ([07b71df](https://togithub.com/octokit/node-github/commit/07b71df))
- set content-length: 0 for put/patch requests with empty body ([54391c7](https://togithub.com/octokit/node-github/commit/54391c7))
- **package:** [@octokit/fixtures](https://togithub.com/octokit/fixtures)@^2.3.1 ([7e4c420](https://togithub.com/octokit/node-github/commit/7e4c420))
##### Chores
- **package:** update dependencies ([cab5531](https://togithub.com/octokit/node-github/commit/cab5531))
##### BREAKING CHANGES
Unmaintained Node Versions (<4) are no longer supported
### [`v11.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v11.0.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v10.1.0...v11.0.0)
See [CHANGELOG.md](https://togithub.com/octokit/node-github/blob/f4845cffb392fcb0671d70e1e2779eabe0c8fd12/CHANGELOG.md) for v11 and below
### [`v10.1.0`](https://togithub.com/octokit/rest.js/compare/v10.0.0...v10.1.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v10.0.0...v10.1.0)
### [`v10.0.0`](https://togithub.com/octokit/rest.js/compare/v9.3.1...v10.0.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v9.3.1...v10.0.0)
### [`v9.3.1`](https://togithub.com/octokit/rest.js/compare/v9.3.0...v9.3.1)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v9.3.0...v9.3.1)
### [`v9.3.0`](https://togithub.com/octokit/rest.js/compare/v9.2.0...v9.3.0)
[Compare Source](https://togithub.com/octokit/rest.js/compare/v9.2.0...v9.3.0)
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
^9.2.0
->^14.0.0
Release Notes
octokit/rest.js
### [`v14.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v14.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v13.1.1...v14.0.0) ##### Breaking changes ##### The package has been renamed from `github` to `@octokit/rest`. To upgrade 1. `npm install @octokit/rest` 2. `npm uninstall github` 3. replace `require('github')` with `require('@octokit/rest')` That’s it, there are no functional changes in the public APIs compared to `github@13`. ##### Debug logs `DEBUG=node-github*` is now `DEBUG=octokit*`. In case you enabled debug logs, make sure to adapt the `DEBUG` environment variable accordingly. ### [`v13.1.1`](https://togithub.com/octokit/rest.js/releases/tag/v13.1.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v13.1.0...v13.1.1) ##### Bug Fixes - **typescript:** improve default response type ([#683](https://togithub.com/octokit/node-github/issues/683)) ([ac39fb5](https://togithub.com/octokit/node-github/commit/ac39fb5)) ### [`v13.1.0`](https://togithub.com/octokit/rest.js/releases/tag/v13.1.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.2...v13.1.0) ##### Features - error on 304s ([#673](https://togithub.com/octokit/node-github/issues/673)) ([a0c65a2](https://togithub.com/octokit/node-github/commit/a0c65a2)) ### [`v13.0.2`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.2) [Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.1...v13.0.2) ##### Bug Fixes - uploadAsset with `file: fs.createReadStream()` ([85255a1](https://togithub.com/octokit/node-github/commit/85255a1)) ### [`v13.0.1`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v13.0.0...v13.0.1) ##### Bug Fixes - respect NO_PROXY environment variable ([#667](https://togithub.com/octokit/node-github/issues/667)) ([9c68105](https://togithub.com/octokit/node-github/commits/9c68105)) ### [`v13.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v13.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.1.0...v13.0.0) ##### BREAKING CHANGES - `.get{Scope name}Api()` methods have been removed. Before you could do this ```js const reposApi = github.getReposApi() ``` Which is the same as doing ```js const reposApi = github.repos ``` So we removed it :) - Before a link header could be passed directly to pagination methods like `github.hasPreviousPage(linkHeaderValue)`. This was never documented and is not being used internally, so we decided to remove the functionality to simplify the code - The `debug` option for the GitHub Client constructor has been removed. Set `DEBUG=node-github:*` environment variable instead - The current implementation has the upload URL hard coded, while the specification says that it has to be received from the Release API endpoint: https://developer.github.com/v3/repos/releases/#upload-a-release-asset The new implementation also requires `contentType` as well as `contentLength`. The latter is not documented, but is required. The `filePath` option has been replaced with a `file` option which can be either a read stream, a buffer or a string. Altogether, uploading an asset before worked like this: ```js github.repos.getReleaseByTag({ owner: "octokit-fixture-org", repo: "release-assets", tag: "v1.0.0" }) .then(result => { return github.repos.uploadAsset({ owner: "octokit-fixture-org", repo: "release-assets", id: result.data.id, filePath: pathResolve(__dirname, "test-upload.txt"), name: "test-upload.txt", label: "test" }) }) ``` Now it looks like this ```js github.repos.getReleaseByTag({ owner: "octokit-fixture-org", repo: "release-assets", tag: "v1.0.0" }) .then(result => { return github.repos.uploadAsset({ url: result.data.upload_url, file: "Hello, world!\n", contentType: "text/plain", contentLength: 14, name: "test-upload.txt", label: "test" }) }) ``` If you prefer a higher-level release asset upload library, have a look at https://github.com/gr2m/octokit-release-asset-upload - the `followRedirects` option has been removed. Previous problems with non-GET redirects should be handled correctly now, the method is always forwarded as all redirects remain within the same host - Authentication with `"netrc"` is no longer supported: ```js github.authenticate({ type: "netrc" }) ``` Instead, use the [netrc](https://www.npmjs.com/package/netrc) package directly and pass username/password to `"basic"` authentication ```js const netrc = require('netrc') const myNetrc = netrc() github.authenticate({ type: 'basic', username: myNetrc['api.github.com'].login, password: myNetrc['api.github.com'].password }) ``` - passing a custom `Promise` option to the constructor is no longer supported All suppertod Node versions (4, 6 and 8) have Promise support built in now. So migrating should be as simple as removing the `Promise` option altogether. ##### Features - always follow redirects ([61e7a81](git+https:github.com/octokit/node-github/commits/61e7a81)) ##### Bug Fixes - no headers are sent if there are no headers ([51eeb0d](git+https:github.com/octokit/node-github/commits/51eeb0d)) ### [`v12.1.0`](https://togithub.com/octokit/rest.js/releases/tag/v12.1.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.7...v12.1.0) ##### Features - add child team list route ([#664](https://togithub.com/octokit/node-github/issues/664)) ([14f18c2](https://togithub.com/octokit/node-github/commit/14f18c2)) ### [`v12.0.7`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.7) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.6...v12.0.7) ##### Bug Fixes - whitelist X-GitHub-SSO header in response ([#663](https://togithub.com/octokit/node-github/issues/663)) ([1e07daf](https://togithub.com/octokit/node-github/commit/1e07daf)) ### [`v12.0.6`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.6) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.5...v12.0.6) ##### Bug Fixes - calculate content-length correctly for raw markdown request ([4f819ad](https://togithub.com/octokit/node-github/commit/4f819ad)) ### [`v12.0.5`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.5) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.4...v12.0.5) ##### Bug Fixes - don’t pass `filePath` as query parameter ([3c2e465](https://togithub.com/octokit/node-github/commit/3c2e465)) ### [`v12.0.4`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.4) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.3...v12.0.4) ##### Bug Fixes - **package:** update follow-redirects to version 1.2.6 ([1667120](https://togithub.com/octokit/node-github/commit/1667120)) ### [`v12.0.3`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.3) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.2...v12.0.3) ##### Bug Fixes - routes.json validation for project cards and columns ([072a53f](https://togithub.com/octokit/node-github/commit/072a53f)) ### [`v12.0.2`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.2) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.1...v12.0.2) ##### Bug Fixes - TypeScript/Flow definitions ([be1d098](https://togithub.com/octokit/node-github/commit/be1d098)) ### [`v12.0.1`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v12.0.0...v12.0.1) ##### Bug Fixes - adapt for mime@2 ([fb0ad88](https://togithub.com/octokit/node-github/commit/fb0ad88)) ### [`v12.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v12.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v11.0.0...v12.0.0) ##### Bug Fixes - remove trailing slash from `/repos/:owner/:repo/git/refs/` ([07b71df](https://togithub.com/octokit/node-github/commit/07b71df)) - set content-length: 0 for put/patch requests with empty body ([54391c7](https://togithub.com/octokit/node-github/commit/54391c7)) - **package:** [@octokit/fixtures](https://togithub.com/octokit/fixtures)@^2.3.1 ([7e4c420](https://togithub.com/octokit/node-github/commit/7e4c420)) ##### Chores - **package:** update dependencies ([cab5531](https://togithub.com/octokit/node-github/commit/cab5531)) ##### BREAKING CHANGES Unmaintained Node Versions (<4) are no longer supported ### [`v11.0.0`](https://togithub.com/octokit/rest.js/releases/tag/v11.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v10.1.0...v11.0.0) See [CHANGELOG.md](https://togithub.com/octokit/node-github/blob/f4845cffb392fcb0671d70e1e2779eabe0c8fd12/CHANGELOG.md) for v11 and below ### [`v10.1.0`](https://togithub.com/octokit/rest.js/compare/v10.0.0...v10.1.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v10.0.0...v10.1.0) ### [`v10.0.0`](https://togithub.com/octokit/rest.js/compare/v9.3.1...v10.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v9.3.1...v10.0.0) ### [`v9.3.1`](https://togithub.com/octokit/rest.js/compare/v9.3.0...v9.3.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v9.3.0...v9.3.1) ### [`v9.3.0`](https://togithub.com/octokit/rest.js/compare/v9.2.0...v9.3.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v9.2.0...v9.3.0)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.