Merge branch 'master' into beta

pvdlg · pvdlg · commit 416fb56a17c7 · 2019-10-02T17:40:09.000-04:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,8 +1,9 @@
 language: node_js
 
 node_js:
+  - 12
   - 10
-  - 8
+  - 8.3
 
 # Trigger a push build on release and greenkeeper branches + PRs build on every branches
 # Avoid double build on PRs (See https://github.com/travis-ci/travis-ci/issues/1147)
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@
 | `publish`          | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets.                                                                                                                           |
 | `addChannel`       | Update a [GitHub release](https://help.github.com/articles/about-releases)'s `pre-release` field.                                                                                                                                        |
 | `success`          | Add a comment to each [GitHub Issue](https://help.github.com/articles/about-issues) or [Pull Request](https://help.github.com/articles/about-pull-requests) resolved by the release and close issues previously open by the `fail` step. |
-| `fail`             | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with informations about the errors that caused the release to fail.                                                                                       |
+| `fail`             | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with information about the errors that caused the release to fail.                                                                                        |
 
 ## Install
 
@@ -117,6 +117,15 @@ can be a `String` (`"dist/**/*.js"` or `"dist/mylib.js"`) or an `Array` of `Stri
 
 If a directory is configured, all the files under this directory and its children will be included.
 
+The `name` and `label` for each assets are generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:
+
+| Parameter     | Description                                                                         |
+|---------------|-------------------------------------------------------------------------------------|
+| `branch`      | The branch from which the release is done.                                          |
+| `lastRelease` | `Object` with `version`, `gitTag` and `gitHead` of the last release.                |
+| `nextRelease` | `Object` with `version`, `gitTag`, `gitHead` and `notes` of the release being done. |
+| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.  |
+
 **Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.
 
 ##### assets examples
@@ -134,6 +143,10 @@ distribution` and `MyLibrary CSS distribution` in the GitHub release.
 `css` files in the `dist` directory and its sub-directories excluding the minified version, plus the
 `build/MyLibrary.zip` file and label it `MyLibrary` in the GitHub release.
 
+`[{path: 'dist/MyLibrary.js', name: 'MyLibrary-${nextRelease.gitTag}.js', label: 'MyLibrary JS (${nextRelease.gitTag}) distribution'}]`: include the file `dist/MyLibrary.js` and upload it to the GitHub release with name `MyLibrary-v1.0.0.js` and label `MyLibrary JS (v1.0.0) distribution` which will generate the link:
+
+> `[MyLibrary JS (v1.0.0) distribution](MyLibrary-v1.0.0.js)`
+
 #### successComment
 
 The message for the issue comments is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:
@@ -157,10 +170,10 @@ The `successComment` `This ${issue.pull_request ? 'pull request' : 'issue'} is i
 
 The message for the issue content is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:
 
-| Parameter | Description                                                                                                                                                                                                                                                                                                             |
-|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `branch`  | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                                                              |
-| `errors`  | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a informations about the error formatted in markdown. |
+| Parameter | Description                                                                                                                                                                                                                                                                                                            |
+|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `branch`  | The branch from which the release had failed.                                                                                                                                                                                                                                                                          |
+| `errors`  | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a information about the error formatted in markdown. |
 
 ##### failComment example
 
diff --git a/index.js b/index.js
@@ -1,3 +1,5 @@
+/* eslint require-atomic-updates: off */
+
 const {defaultTo, castArray} = require('lodash');
 const verifyGitHub = require('./lib/verify');
 const addChannelGitHub = require('./lib/add-channel');
diff --git a/lib/add-channel.js b/lib/add-channel.js
@@ -16,7 +16,7 @@ module.exports = async (pluginConfig, context) => {
   const {githubToken, githubUrl, githubApiPathPrefix, proxy} = resolveConfig(pluginConfig, context);
   const {name: repo, owner} = parseGithubUrl(repositoryUrl);
   const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
-  let release_id;
+  let releaseId;
 
   const release = {owner, repo, name, prerelease: isPrerelease(branch)};
 
@@ -28,7 +28,7 @@ module.exports = async (pluginConfig, context) => {
 
   try {
     ({
-      data: {id: release_id},
+      data: {id: releaseId},
     } = await github.repos.getReleaseByTag({owner, repo, tag: currentGitTag}));
   } catch (error) {
     if (error.status === 404) {
@@ -47,14 +47,14 @@ module.exports = async (pluginConfig, context) => {
     throw error;
   }
 
-  const tag_name = currentChannel ? gitTag : undefined;
+  const tagName = currentChannel ? gitTag : undefined;
 
-  debug('release release_id: %o', release_id);
-  debug('release tag_name: %o', tag_name);
+  debug('release release_id: %o', releaseId);
+  debug('release tag_name: %o', tagName);
 
   const {
     data: {html_url: url},
-  } = await github.repos.updateRelease({...release, release_id, tag_name});
+  } = await github.repos.updateRelease({...release, release_id: releaseId, tag_name: tagName});
 
   logger.log('Updated GitHub release: %s', url);
 
diff --git a/lib/get-fail-comment.js b/lib/get-fail-comment.js
@@ -7,9 +7,9 @@ const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
 const formatError = error => `### ${error.message}
 
 ${error.details ||
-  `Unfortunatly this error doesn't have any additionnal information.${
+  `Unfortunately this error doesn't have any additional information.${
     error.pluginName
-      ? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful informations.`
+      ? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful information.`
       : ''
   }`}`;
 
diff --git a/lib/publish.js b/lib/publish.js
@@ -1,6 +1,6 @@
 const {basename, extname, resolve} = require('path');
 const {stat, readFile} = require('fs-extra');
-const {isPlainObject} = require('lodash');
+const {isPlainObject, template} = require('lodash');
 const parseGithubUrl = require('parse-github-url');
 const mime = require('mime');
 const debug = require('debug')('semantic-release:github');
@@ -40,7 +40,7 @@ module.exports = async (pluginConfig, context) => {
   const draftRelease = {...release, draft: true};
 
   const {
-    data: {html_url: url, upload_url: uploadUrl, id: releaseId},
+    data: {upload_url: uploadUrl, id: releaseId},
   } = await github.repos.createRelease(draftRelease);
 
   // Append assets to the release
@@ -54,7 +54,7 @@ module.exports = async (pluginConfig, context) => {
 
       try {
         file = await stat(resolve(cwd, filePath));
-      } catch (error) {
+      } catch (_) {
         logger.error('The asset %s cannot be read, and will be ignored.', filePath);
         return;
       }
@@ -64,7 +64,7 @@ module.exports = async (pluginConfig, context) => {
         return;
       }
 
-      const fileName = asset.name || basename(filePath);
+      const fileName = template(asset.name || basename(filePath))(context);
       const upload = {
         url: uploadUrl,
         file: await readFile(resolve(cwd, filePath)),
@@ -79,7 +79,7 @@ module.exports = async (pluginConfig, context) => {
       debug('file name: %o', fileName);
 
       if (isPlainObject(asset) && asset.label) {
-        upload.label = asset.label;
+        upload.label = template(asset.label)(context);
       }
 
       const {
@@ -89,7 +89,9 @@ module.exports = async (pluginConfig, context) => {
     })
   );
 
-  await github.repos.updateRelease({owner, repo, release_id: releaseId, draft: false});
+  const {
+    data: {html_url: url},
+  } = await github.repos.updateRelease({owner, repo, release_id: releaseId, draft: false});
 
   logger.log('Published GitHub release: %s', url);
   return {url, name: RELEASE_NAME};
diff --git a/lib/success.js b/lib/success.js
@@ -30,9 +30,11 @@ module.exports = async (pluginConfig, context) => {
   } = resolveConfig(pluginConfig, context);
 
   const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
-  let {name: repo, owner} = parseGithubUrl(repositoryUrl);
+  const parsedUrl = parseGithubUrl(repositoryUrl);
   // In case the repo changed name, get the new `repo`/`owner` as the search API will not follow redirects
-  [owner, repo] = (await github.repos.get({repo, owner})).data.full_name.split('/');
+  const [owner, repo] = (await github.repos.get({repo: parsedUrl.name, owner: parsedUrl.owner})).data.full_name.split(
+    '/'
+  );
 
   const errors = [];
 
diff --git a/package.json b/package.json
@@ -11,11 +11,6 @@
   "bugs": {
     "url": "https://github.com/semantic-release/github/issues"
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
   "contributors": [
     "Stephan Bönnemann <stephan@boennemann.me> (http://boennemann.me)",
     "Gregor Martynus (https://twitter.com/gr2m)"
@@ -28,7 +23,7 @@
     "debug": "^4.0.0",
     "dir-glob": "^3.0.0",
     "fs-extra": "^8.0.0",
-    "globby": "^9.0.0",
+    "globby": "^10.0.0",
     "http-proxy-agent": "^2.1.0",
     "https-proxy-agent": "^2.2.1",
     "issue-parser": "^4.0.0",
@@ -41,19 +36,17 @@
   },
   "devDependencies": {
     "ava": "^2.0.0",
-    "clear-module": "^3.0.0",
+    "clear-module": "^4.0.0",
     "codecov": "^3.5.0",
-    "commitizen": "^3.0.0",
-    "cz-conventional-changelog": "^2.0.0",
-    "nock": "^10.0.0",
+    "nock": "^11.1.0",
     "nyc": "^14.1.1",
     "proxy": "^0.2.4",
     "proxyquire": "^2.0.0",
     "semantic-release": "^16.0.0-beta",
     "server-destroy": "^1.0.1",
     "sinon": "^7.1.1",
     "tempy": "^0.3.0",
-    "xo": "^0.24.0"
+    "xo": "^0.25.2"
   },
   "engines": {
     "node": ">=8.3"
@@ -103,7 +96,6 @@
     "url": "https://github.com/semantic-release/github.git"
   },
   "scripts": {
-    "cm": "git-cz",
     "codecov": "codecov -f coverage/coverage-final.json",
     "lint": "xo",
     "pretest": "npm run lint",
@@ -117,12 +109,7 @@
       "camelcase": [
         "error",
         {
-          "allow": [
-            "issue_number",
-            "pull_number",
-            "tag_name",
-            "release_id"
-          ]
+          "properties": "never"
         }
       ]
     }
diff --git a/test/get-fail-comment.test.js b/test/get-fail-comment.test.js
@@ -34,7 +34,7 @@ test('Comment with missing error details and pluginName', t => {
   t.regex(comment, /the `master` branch/);
   t.regex(
     comment,
-    /---\n\n### Error message 1\n\nUnfortunatly this error doesn't have any additionnal information. Feel free to kindly ask the author of the `some-plugin` plugin to add more helpful informations.\n\n---/
+    /---\n\n### Error message 1\n\nUnfortunately this error doesn't have any additional information. Feel free to kindly ask the author of the `some-plugin` plugin to add more helpful information.\n\n---/
   );
 });
 
@@ -46,6 +46,6 @@ test('Comment with missing error details and no pluginName', t => {
   t.regex(comment, /the `master` branch/);
   t.regex(
     comment,
-    /---\n\n### Error message 1\n\nUnfortunatly this error doesn't have any additionnal information.\n\n---/
+    /---\n\n### Error message 1\n\nUnfortunately this error doesn't have any additional information.\n\n---/
   );
 });
diff --git a/test/get-success-comment.test.js b/test/get-success-comment.test.js
@@ -25,7 +25,7 @@ Your **[semantic-release](${HOME_URL})** bot :package::rocket:`
 });
 
 test('Comment for PR with multiple releases', t => {
-  const issue = {number: 1, pull_request: {}}; // eslint-disable-line camelcase
+  const issue = {number: 1, pull_request: {}};
   const releaseInfos = [
     {name: 'GitHub release', url: 'https://github.com/release'},
     {name: 'npm release', url: 'https://npm.com/release'},
diff --git a/test/integration.test.js b/test/integration.test.js
@@ -10,8 +10,6 @@ import SemanticReleaseError from '@semantic-release/error';
 import {authenticate, upload} from './helpers/mock-github';
 import rateLimit from './helpers/rate-limit';
 
-/* eslint camelcase: ["error", {properties: "never"}] */
-
 const cwd = 'test/fixtures/files';
 const client = proxyquire('../lib/get-client', {'./definitions/rate-limit': rateLimit});
 
@@ -185,6 +183,63 @@ test.serial('Publish a release with an array of assets', async t => {
   t.true(githubUpload2.isDone());
 });
 
+test.serial('Publish a release with release information in assets', async t => {
+  const owner = 'test_user';
+  const repo = 'test_repo';
+  const env = {GITHUB_TOKEN: 'github_token'};
+  const assets = [
+    {
+      path: ['upload.txt'],
+      name: `file_with_release_\${nextRelease.gitTag}_in_filename.txt`,
+      label: `File with release \${nextRelease.gitTag} in label`,
+    },
+  ];
+  const nextRelease = {gitTag: 'v1.0.0', name: 'v1.0.0', notes: 'Test release note body'};
+  const options = {repositoryUrl: `https://github.com/${owner}/${repo}.git`};
+  const releaseUrl = `https://github.com/${owner}/${repo}/releases/${nextRelease.version}`;
+  const assetUrl = `https://github.com/${owner}/${repo}/releases/download/${nextRelease.version}/file_with_release_v1.0.0_in_filename.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(env)
+    .get(`/repos/${owner}/${repo}`)
+    .reply(200, {permissions: {push: true}})
+    .post(`/repos/${owner}/${repo}/releases`, {
+      tag_name: nextRelease.gitTag,
+      target_commitish: options.branch,
+      name: nextRelease.gitTag,
+      body: nextRelease.notes,
+      draft: true,
+    })
+    .reply(200, {upload_url: uploadUrl, html_url: releaseUrl, id: releaseId})
+    .patch(`/repos/${owner}/${repo}/releases/${releaseId}`, {
+      draft: false,
+    })
+    .reply(200, {html_url: releaseUrl});
+  const githubUpload = upload(env, {
+    uploadUrl: 'https://github.com',
+    contentLength: (await stat(path.resolve(cwd, 'upload.txt'))).size,
+  })
+    .post(
+      `${uploadUri}?name=${escape('file_with_release_v1.0.0_in_filename.txt')}&label=${escape(
+        'File with release v1.0.0 in label'
+      )}`
+    )
+    .reply(200, {browser_download_url: assetUrl});
+
+  const result = await t.context.m.publish(
+    {assets},
+    {cwd, env, options, branch: {type: 'release'}, nextRelease, logger: t.context.logger}
+  );
+
+  t.is(result.url, releaseUrl);
+  t.deepEqual(t.context.log.args[0], ['Verify GitHub authentication']);
+  t.true(t.context.log.calledWith('Published file %s', assetUrl));
+  t.true(t.context.log.calledWith('Published GitHub release: %s', releaseUrl));
+  t.true(github.isDone());
+  t.true(githubUpload.isDone());
+});
+
 test.serial('Update a release', async t => {
   const owner = 'test_user';
   const repo = 'test_repo';
diff --git a/test/publish.test.js b/test/publish.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/* eslint require-atomic-updates: off */`
	`2`	`+`
`1`	`3`	`const {defaultTo, castArray} = require('lodash');`
`2`	`4`	`const verifyGitHub = require('./lib/verify');`
`3`	`5`	`const addChannelGitHub = require('./lib/add-channel');`