fix(package): update github to version 13.0.0

Author: gr2m

lib/publish.js

@@ -1,10 +1,11 @@
-const {basename} = require('path');
+const {basename, extname} = require('path');
 const {parse} = require('url');
-const {stat} = require('fs-extra');
+const {stat, readFile} = require('fs-extra');
 const parseGithubUrl = require('parse-github-url');
 const GitHubApi = require('github');
 const pEachSeries = require('p-each-series');
 const debug = require('debug')('semantic-release:publish-github');
+const mime = require('mime');
 const resolveConfig = require('./resolve-config');
 
 module.exports = async (pluginConfig, {branch, repositoryUrl}, {version, gitHead, gitTag, notes}, logger) => {
@@ -35,8 +36,8 @@ module.exports = async (pluginConfig, {branch, repositoryUrl}, {version, gitHead
     await github.gitdata.createReference({owner, repo, ref, sha: gitHead});
   }
 
-  const {data: {id, html_url}} = await github.repos.createRelease(release); // eslint-disable-line camelcase
-  logger.log('Published Github release: %s', html_url);
+  const {data: {html_url: htmlUrl, upload_url: uploadUrl}} = await github.repos.createRelease(release);
+  logger.log('Published Github release: %s', htmlUrl);
 
   if (assets && assets.length > 0) {
     // Make requests serially to avoid hitting the rate limit (https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)
@@ -54,15 +55,23 @@ module.exports = async (pluginConfig, {branch, repositoryUrl}, {version, gitHead
         return;
       }
       const fileName = asset.name || basename(filePath);
-      const upload = {owner, repo, id, filePath, name: fileName};
+      const upload = {
+        owner,
+        repo,
+        url: uploadUrl,
+        file: await readFile(filePath),
+        contentType: mime.getType(extname(fileName)),
+        contentLength: file.size,
+        name: fileName,
+      };
       debug('file path: %o', filePath);
       debug('file name: %o', fileName);
       if (asset.label) {
         upload.label = asset.label;
       }
 
-      const {data: {browser_download_url}} = await github.repos.uploadAsset(upload); // eslint-disable-line camelcase
-      logger.log('Published file %s', browser_download_url);
+      const {data: {browser_download_url: downloadUrl}} = await github.repos.uploadAsset(upload);
+      logger.log('Published file %s', downloadUrl);
     });
   }
 };

package.json

@@ -19,7 +19,8 @@
     "@semantic-release/error": "^2.1.0",
     "debug": "^3.1.0",
     "fs-extra": "^4.0.2",
-    "github": "^12.0.5",
+    "github": "^13.0.0",
+    "mime": "^2.0.3",
     "p-each-series": "^1.0.0",
     "parse-github-url": "^1.0.1"
   },

test/helpers/mock-github.js

@@ -18,11 +18,11 @@ export function authenticate(
  * Retun a `nock` object setup to respond to a github release upload request. Other expectation and responses can be chained.
  *
  * @param {String} [githubToken='GH_TOKEN'] The github token to return in the authentication response.
- * @param {String} [githubUrl='https://uploads.github.com'] The url on which to intercept http requests.
+ * @param {String} [uploadUrl] The url on which to intercept http requests.
  * @return {Object} A `nock` object ready to respond to a github file upload request.
  */
-export function upload({githubToken = 'GH_TOKEN', githubUrl = 'https://uploads.github.com'} = {}) {
-  return nock(`${githubUrl}${githubUrl === 'https://uploads.github.com' ? '' : '/api/uploads'}`, {
-    reqheaders: {Authorization: `token ${githubToken}`},
+export function upload({githubToken = 'GH_TOKEN', uploadUrl, contentType = 'text/plain', contentLength} = {}) {
+  return nock(uploadUrl, {
+    reqheaders: {Authorization: `token ${githubToken}`, 'content-type': contentType, 'content-length': contentLength},
   });
 }

test/integration.test.js

@@ -1,5 +1,6 @@
 import {escape} from 'querystring';
 import test from 'ava';
+import {stat} from 'fs-extra';
 import {stub, match} from 'sinon';
 import clearModule from 'clear-module';
 import SemanticReleaseError from '@semantic-release/error';
@@ -113,6 +114,8 @@ test.serial('Publish a release with an array of assets', async t => {
   const assetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/upload.txt`;
   const otherAssetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/other_file.txt`;
   const releaseId = 1;
+  const uploadUri = `/api/uploads/repos/${owner}/${repo}/releases/${releaseId}/assets`;
+  const uploadUrl = `https://github.com${uploadUri}{?name,label}`;
 
   const github = authenticate({githubToken})
     .get(`/repos/${owner}/${repo}`)
@@ -127,16 +130,22 @@ test.serial('Publish a release with an array of assets', async t => {
       name: nextRelease.gitTag,
       body: nextRelease.notes,
     })
-    .reply(200, {html_url: releaseUrl, id: releaseId});
-
-  const githubUpload = upload({githubToken})
-    .post(`/repos/${owner}/${repo}/releases/${releaseId}/assets?name=${escape('upload.txt')}`)
-    .reply(200, {browser_download_url: assetUrl})
-    .post(
-      `/repos/${owner}/${repo}/releases/${releaseId}/assets?name=${escape('other_file.txt')}&label=${escape(
-        'Other File'
-      )}`
-    )
+    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl});
+
+  const githubUpload1 = upload({
+    githubToken,
+    uploadUrl: 'https://github.com',
+    contentLength: (await stat('test/fixtures/upload.txt')).size,
+  })
+    .post(`${uploadUri}?name=${escape('upload.txt')}`)
+    .reply(200, {browser_download_url: assetUrl});
+
+  const githubUpload2 = upload({
+    githubToken,
+    uploadUrl: 'https://github.com',
+    contentLength: (await stat('test/fixtures/upload_other.txt')).size,
+  })
+    .post(`${uploadUri}?name=${escape('other_file.txt')}&label=${escape('Other File')}`)
     .reply(200, {browser_download_url: otherAssetUrl});
 
   await t.context.m.publish({githubToken, assets}, {nextRelease, options, logger: t.context.logger});
@@ -145,7 +154,8 @@ test.serial('Publish a release with an array of assets', async t => {
   t.true(t.context.log.calledWith(match.string, assetUrl));
   t.true(t.context.log.calledWith(match.string, otherAssetUrl));
   t.true(github.isDone());
-  t.true(githubUpload.isDone());
+  t.true(githubUpload1.isDone());
+  t.true(githubUpload2.isDone());
 });
 
 test.serial('Verify Github auth and release', async t => {
@@ -166,6 +176,8 @@ test.serial('Verify Github auth and release', async t => {
   const assetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/upload.txt`;
   const otherAssetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/other_file.txt`;
   const releaseId = 1;
+  const uploadUri = `/api/uploads/repos/${owner}/${repo}/releases/${releaseId}/assets`;
+  const uploadUrl = `https://github.com${uploadUri}{?name,label}`;
 
   const github = authenticate({githubToken: process.env.GH_TOKEN})
     .get(`/repos/${owner}/${repo}`)
@@ -180,16 +192,22 @@ test.serial('Verify Github auth and release', async t => {
       name: nextRelease.gitTag,
       body: nextRelease.notes,
     })
-    .reply(200, {html_url: releaseUrl, id: releaseId});
-
-  const githubUpload = upload({githubToken: process.env.GH_TOKEN})
-    .post(`/repos/${owner}/${repo}/releases/${releaseId}/assets?name=${escape('upload.txt')}`)
-    .reply(200, {browser_download_url: assetUrl})
-    .post(
-      `/repos/${owner}/${repo}/releases/${releaseId}/assets?name=${escape('other_file.txt')}&label=${escape(
-        'Other File'
-      )}`
-    )
+    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl});
+
+  const githubUpload1 = upload({
+    githubToken: process.env.GH_TOKEN,
+    uploadUrl: 'https://github.com',
+    contentLength: (await stat('test/fixtures/upload.txt')).size,
+  })
+    .post(`${uploadUri}?name=${escape('upload.txt')}`)
+    .reply(200, {browser_download_url: assetUrl});
+
+  const githubUpload2 = upload({
+    githubToken: process.env.GH_TOKEN,
+    uploadUrl: 'https://github.com',
+    contentLength: (await stat('test/fixtures/upload_other.txt')).size,
+  })
+    .post(`${uploadUri}?name=${escape('other_file.txt')}&label=${escape('Other File')}`)
     .reply(200, {browser_download_url: otherAssetUrl});
 
   await t.notThrows(t.context.m.verifyConditions({}, {options}));
@@ -199,5 +217,6 @@ test.serial('Verify Github auth and release', async t => {
   t.true(t.context.log.calledWith(match.string, assetUrl));
   t.true(t.context.log.calledWith(match.string, otherAssetUrl));
   t.true(github.isDone());
-  t.true(githubUpload.isDone());
+  t.true(githubUpload1.isDone());
+  t.true(githubUpload2.isDone());
 });