octokit / node-github / 121 / 3

100%

master: 100%

Pull #629

travis-ci

fix: github.repos.uploadAsset() options

BREAKING CHANGE: 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  repo: "release-assets  repo: "release-assets  repo: "release-assets  repo: "release-assets  repo: "release-assets  repo: "release-assets  repo: "release-assett/  repo: "release-assets  repo: "release-assets  repo: "releas   label: "test"
  })
})
```

If you prefer a higher-level release asset upload library, have a look at https://github.com/gr2m/octokit-release-asset-upload

182 of 308 branches covered (59.09%)

Branch coverage included in aggregate %.

267 of 418 relevant lines covered (63.88%)

202.49 hits per line