@semantic-release/github 4.2.18 → 4.4.2

package/README.md

@@ -50,6 +50,7 @@ Follow the [Creating a personal access token for the command line](https://help.
 |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `githubUrl`           | The GitHub Enterprise endpoint.                                                                                                                              | `GH_URL` or `GITHUB_URL` environment variable.                                                                                                       |
 | `githubApiPathPrefix` | The GitHub Enterprise API prefix.                                                                                                                            | `GH_PREFIX` or `GITHUB_PREFIX` environment variable.                                                                                                 |
+| `proxy`               | The proxy to use to access the GitHub API. See [proxy](#proxy).                                                                                              | `HTTP_PROXY` environment variable.                                                                                                                   |
 | `assets`              | An array of files to upload to the release. See [assets](#assets).                                                                                           | -                                                                                                                                                    |
 | `successComment`      | The comment added to each issue and pull request resolved by the release. See [successComment](#successcomment).                                             | `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\n\nThe release is available on [GitHub release](<github_release_url>)` |
 | `failComment`         | The content of the issue created when a release fails. See [failComment](#failcomment).                                                                      | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail.              |
@@ -59,10 +60,28 @@ Follow the [Creating a personal access token for the command line](https://help.
 
 **Note**: If you use a [shareable configuration](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/shareable-configurations.md#shareable-configurations) that defines one of these options you can set it to `false` in your [**semantic-release** configuration](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/configuration.md#configuration) in order to use the default value.
 
+#### proxy
+
+Can be a the proxy URL or and `Object` with the following properties:
+
+| Property      | Description                                                    | Default                              |
+|---------------|----------------------------------------------------------------|--------------------------------------|
+| `host`        | **Required.** Proxy host to connect to.                        | -                                    |
+| `port`        | **Required.** Proxy port to connect to.                        | File name extracted from the `path`. |
+| `secureProxy` | If `true`, then use TLS to connect to the proxy.               | `false`                              |
+| `headers`     | Additional HTTP headers to be sent on the HTTP CONNECT method. | -                                    |
+
+See [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) for additional details.
+
+##### proxy examples
+
+`'http://168.63.76.32:3128'`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request.
+`{host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request, setting the `Foo` header value to `bar`.
+
 #### assets
 
 Can be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of
-[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties
+[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties:
 
 | Property | Description                                                                                              | Default                              |
 | -------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |
@@ -76,7 +95,7 @@ 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.
 
-Files can be included even if they have a match in `.gitignore`.
+**Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.
 
 ##### assets examples
 

package/lib/definitions/errors.js

@@ -43,7 +43,7 @@ Your configuration for the \`failComment\` option is \`${stringify(failComment)}
   EINVALIDLABELS: ({labels}) => ({
     message: 'Invalid `labels` option.',
     details: `The [labels option](${linkify(
-      'README.md#labels'
+      'README.md#options'
     )}) option, if defined, must be an \`Array\` of non empty \`String\`.
 
 Your configuration for the \`labels\` option is \`${stringify(labels)}\`.`,
@@ -51,7 +51,7 @@ Your configuration for the \`labels\` option is \`${stringify(labels)}\`.`,
   EINVALIDASSIGNEES: ({assignees}) => ({
     message: 'Invalid `assignees` option.',
     details: `The [assignees option](${linkify(
-      'README.md#assignees'
+      'README.md#options'
     )}) option must be an \`Array\` of non empty \`Strings\`.
 
 Your configuration for the \`assignees\` option is \`${stringify(assignees)}\`.`,
@@ -61,6 +61,14 @@ Your configuration for the \`assignees\` option is \`${stringify(assignees)}\`.`
     details: `The **semantic-release** \`repositoryUrl\` option must a valid GitHub URL with the format \`<GitHub_or_GHE_URL>/<owner>/<repo>.git\`.
 
 By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.`,
+  }),
+  EINVALIDPROXY: ({proxy}) => ({
+    message: 'Invalid `proxy` option.',
+    details: `The [proxy option](${linkify(
+      'README.md#proxy'
+    )}) option must be a \`String\`  or an \`Objects\` with a \`host\` and a \`port\` property.
+
+Your configuration for the \`proxy\` option is \`${stringify(proxy)}\`.`,
   }),
   EMISSINGREPO: ({owner, repo}) => ({
     message: `The repository ${owner}/${repo} doesn't exist.`,

package/lib/definitions/rate-limit.js

@@ -0,0 +1,27 @@
+/**
+ * Default exponential backoff configuration for retries.
+ */
+const RETRY_CONF = {retries: 3, factor: 2, minTimeout: 1000};
+
+/**
+ * Rate limit per API endpoints.
+ *
+ * See {@link https://developer.github.com/v3/search/#rate-limit|Search API rate limit}.
+ * See {@link https://developer.github.com/v3/#rate-limiting|Rate limiting}.
+ */
+const RATE_LIMITS = {
+  search: ((60 * 1000) / 30) * 1.1, // 30 calls per minutes => 1 call every 2s + 10% safety margin
+  core: {
+    read: ((60 * 60 * 1000) / 5000) * 1.1, // 5000 calls per hour => 1 call per 720ms + 10% safety margin
+    write: 3000, // 1 call every 3 seconds
+  },
+};
+
+/**
+ * Global rate limit to prevent abuse.
+ *
+ * See {@link https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits|Dealing with abuse rate limits}
+ */
+const GLOBAL_RATE_LIMIT = 1000;
+
+module.exports = {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT};

package/lib/fail.js

@@ -8,11 +8,11 @@ const findSRIssues = require('./find-sr-issues');
 const getFailComment = require('./get-fail-comment');
 
 module.exports = async (pluginConfig, {options: {branch, repositoryUrl}, errors, logger}) => {
-  const {githubToken, githubUrl, githubApiPathPrefix, failComment, failTitle, labels, assignees} = resolveConfig(
+  const {githubToken, githubUrl, githubApiPathPrefix, proxy, failComment, failTitle, labels, assignees} = resolveConfig(
     pluginConfig
   );
   const {name: repo, owner} = parseGithubUrl(repositoryUrl);
-  const github = getClient({githubToken, githubUrl, githubApiPathPrefix});
+  const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
   const body = failComment ? template(failComment)({branch, errors}) : getFailComment(branch, errors);
   const [srIssue] = await findSRIssues(github, failTitle, owner, repo);
 

package/lib/get-client.js

@@ -1,31 +1,14 @@
-const {memoize} = require('lodash');
+const url = require('url');
+const {memoize, get} = require('lodash');
 const Octokit = require('@octokit/rest');
 const pRetry = require('p-retry');
 const Bottleneck = require('bottleneck');
 const urljoin = require('url-join');
+const HttpProxyAgent = require('http-proxy-agent');
+const HttpsProxyAgent = require('https-proxy-agent');
 
-/**
- * Default exponential backoff configuration for retries.
- */
-const DEFAULT_RETRY = {retries: 3, factor: 2, minTimeout: 1000};
-
-/**
- * Rate limit per API endpoints.
- *
- * See {@link https://developer.github.com/v3/search/#rate-limit|Search API rate limit}.
- * See {@link https://developer.github.com/v3/#rate-limiting|Rate limiting}.
- */
-const RATE_LIMITS = {
-  search: (60 * 1000) / 30, // 30 calls per minutes => 1 call per 2s
-  core: (60 * 60 * 1000) / 5000, // 5000 calls per hour => 1 call per 720ms
-};
-
-/**
- * Global rate limit to prevent abuse.
- *
- * See {@link https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits|Dealing with abuse rate limits}
- */
-const GLOBAL_RATE_LIMIT = 1000;
+const GH_ROUTES = require('@octokit/rest/lib/routes');
+const {RETRY_CONF, RATE_LIMITS, GLOBAL_RATE_LIMIT} = require('./definitions/rate-limit');
 
 /**
  * Http error codes for which to not retry.
@@ -38,35 +21,66 @@ const SKIP_RETRY_CODES = [400, 401, 403];
  * @param {Array} rate The rate limit group.
  * @param {String} limit The rate limits per API endpoints.
  * @param {Bottleneck} globalThrottler The global throttler.
+ *
  * @return {Bottleneck} The throller function for the given rate limit group.
  */
-const getThrottler = memoize((rate, limit, globalThrottler) =>
-  new Bottleneck({minTime: limit[rate]}).chain(globalThrottler)
+const getThrottler = memoize((rate, globalThrottler) =>
+  new Bottleneck({minTime: get(RATE_LIMITS, rate)}).chain(globalThrottler)
 );
 
+/**
+ * Determine if a call to a client function will trigger a read (`GET`) or a write (`POST`, `PATCH`, etc...) request.
+ *
+ * @param {String} endpoint The client API enpoint (for example the endpoint for a call to `github.repos.get` is `repos`).
+ * @param {String} command The client API command (for example the command for a call to `github.repos.get` is `get`).
+ *
+ * @return {String} `write` or `read` if there is rate limit configuration for this `endpoint` and `command`, `undefined` otherwise.
+ */
+const getAccess = (endpoint, command) => {
+  const method = GH_ROUTES[endpoint] && GH_ROUTES[endpoint][command] && GH_ROUTES[endpoint][command].method;
+  const access = method && method === 'GET' ? 'read' : 'write';
+  return RATE_LIMITS[endpoint][access] && access;
+};
+
+/**
+ * Get the limiter identifier associated with a client API call.
+ *
+ * @param {String} endpoint The client API enpoint (for example the endpoint for a call to `github.repos.get` is `repos`).
+ * @param {String} command The client API command (for example the command for a call to `github.repos.get` is `get`).
+ *
+ * @return {String} A string identifying the limiter to use for this `endpoint` and `command` (e.g. `search` or `core.write`).
+ */
+const getLimitKey = (endpoint, command) => {
+  return endpoint
+    ? [endpoint, RATE_LIMITS[endpoint] && getAccess(endpoint, command)].filter(Boolean).join('.')
+    : RATE_LIMITS[command]
+      ? command
+      : 'core';
+};
+
 /**
  * Create a`handler` for a `Proxy` wrapping an Octokit instance to:
  * - Recursively wrap the child objects of the Octokit instance in a `Proxy`
  * - Throttle and retry the Octokit instance functions
  *
- * @param {Object} retry The configuration to pass to `p-retry`.
- * @param {Array} limit The rate limits per API endpoints.
  * @param {Throttler} globalThrottler The throller function for the global rate limit.
- * @param {String} endpoint The API endpoint to handle.
+ * @param {String} limitKey The key to find the limit rate for the  API endpoint and method.
+ *
  * @return {Function} The `handler` for a `Proxy` wrapping an Octokit instance.
  */
-const handler = (retry, limit, globalThrottler, endpoint) => ({
+const handler = (globalThrottler, limitKey) => ({
   /**
    * If the target has the property as own, determine the rate limit based on the property name and recursively wrap the value in a `Proxy`. Otherwise returns the property value.
    *
    * @param {Object} target The target object.
    * @param {String} name The name of the property to get.
    * @param {Any} receiver The `Proxy` object.
+   *
    * @return {Any} The property value or a `Proxy` of the property value.
    */
   get: (target, name, receiver) =>
     Reflect.apply(Object.prototype.hasOwnProperty, target, [name])
-      ? new Proxy(target[name], handler(retry, limit, globalThrottler, endpoint || name))
+      ? new Proxy(target[name], handler(globalThrottler, getLimitKey(limitKey, name)))
       : Reflect.get(target, name, receiver),
 
   /**
@@ -75,11 +89,11 @@ const handler = (retry, limit, globalThrottler, endpoint) => ({
    * @param {Function} func The target function.
    * @param {Any} that The this argument for the call.
    * @param {Array} args The list of arguments for the call.
+   *
    * @return {Promise<Any>} The result of the function called.
    */
   apply: (func, that, args) => {
-    const throttler = getThrottler(limit[endpoint] ? endpoint : 'core', limit, globalThrottler);
-
+    const throttler = getThrottler(limitKey, globalThrottler);
     return pRetry(async () => {
       try {
         return await throttler.wrap(func)(...args);
@@ -89,20 +103,20 @@ const handler = (retry, limit, globalThrottler, endpoint) => ({
         }
         throw err;
       }
-    }, retry);
+    }, RETRY_CONF);
   },
 });
 
-module.exports = ({
-  githubToken,
-  githubUrl,
-  githubApiPathPrefix,
-  retry = DEFAULT_RETRY,
-  limit = RATE_LIMITS,
-  globalLimit = GLOBAL_RATE_LIMIT,
-}) => {
+module.exports = ({githubToken, githubUrl, githubApiPathPrefix, proxy} = {}) => {
   const baseUrl = githubUrl && urljoin(githubUrl, githubApiPathPrefix);
-  const github = new Octokit({baseUrl});
+  const github = new Octokit({
+    baseUrl,
+    agent: proxy
+      ? baseUrl && url.parse(baseUrl).protocol.replace(':', '') === 'http'
+        ? new HttpProxyAgent(proxy)
+        : new HttpsProxyAgent(proxy)
+      : undefined,
+  });
   github.authenticate({type: 'token', token: githubToken});
-  return new Proxy(github, handler(retry, limit, new Bottleneck({minTime: globalLimit})));
+  return new Proxy(github, handler(new Bottleneck({minTime: GLOBAL_RATE_LIMIT})));
 };

package/lib/publish.js

@@ -9,9 +9,9 @@ const resolveConfig = require('./resolve-config');
 const getClient = require('./get-client');
 
 module.exports = async (pluginConfig, {options: {branch, repositoryUrl}, nextRelease: {gitTag, notes}, logger}) => {
-  const {githubToken, githubUrl, githubApiPathPrefix, assets} = resolveConfig(pluginConfig);
+  const {githubToken, githubUrl, githubApiPathPrefix, proxy, assets} = resolveConfig(pluginConfig);
   const {name: repo, owner} = parseGithubUrl(repositoryUrl);
-  const github = getClient({githubToken, githubUrl, githubApiPathPrefix});
+  const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
   const release = {owner, repo, tag_name: gitTag, name: gitTag, target_commitish: branch, body: notes}; // eslint-disable-line camelcase
 
   debug('release owner: %o', owner);

package/lib/resolve-config.js

@@ -3,6 +3,7 @@ const {isUndefined, castArray} = require('lodash');
 module.exports = ({
   githubUrl,
   githubApiPathPrefix,
+  proxy,
   assets,
   successComment,
   failTitle,
@@ -13,6 +14,7 @@ module.exports = ({
   githubToken: process.env.GH_TOKEN || process.env.GITHUB_TOKEN,
   githubUrl: githubUrl || process.env.GH_URL || process.env.GITHUB_URL,
   githubApiPathPrefix: githubApiPathPrefix || process.env.GH_PREFIX || process.env.GITHUB_PREFIX || '',
+  proxy: proxy || process.env.HTTP_PROXY,
   assets: assets ? castArray(assets) : assets,
   successComment,
   failTitle: isUndefined(failTitle) || failTitle === false ? 'The automated release is failing 🚨' : failTitle,

package/lib/success.js

@@ -2,7 +2,7 @@ const {isUndefined, uniqBy, template, flatten} = require('lodash');
 const parseGithubUrl = require('parse-github-url');
 const pFilter = require('p-filter');
 const AggregateError = require('aggregate-error');
-const issueParser = require('issue-parser')('github');
+const issueParser = require('issue-parser');
 const debug = require('debug')('semantic-release:github');
 const resolveConfig = require('./resolve-config');
 const getClient = require('./get-client');
@@ -14,9 +14,10 @@ module.exports = async (
   pluginConfig,
   {options: {branch, repositoryUrl}, lastRelease, commits, nextRelease, releases, logger}
 ) => {
-  const {githubToken, githubUrl, githubApiPathPrefix, successComment, failTitle} = resolveConfig(pluginConfig);
+  const {githubToken, githubUrl, githubApiPathPrefix, proxy, successComment, failTitle} = resolveConfig(pluginConfig);
   const {name: repo, owner} = parseGithubUrl(repositoryUrl);
-  const github = getClient({githubToken, githubUrl, githubApiPathPrefix});
+  const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
+  const parser = issueParser('github', githubUrl ? {hosts: [githubUrl]} : {});
   const releaseInfos = releases.filter(release => Boolean(release.name));
   const shas = commits.map(commit => commit.hash);
   const treeShas = commits.map(commit => commit.tree.long);
@@ -37,7 +38,7 @@ module.exports = async (
   const issues = [...prs.map(pr => pr.body), ...commits.map(commit => commit.message)].reduce((issues, message) => {
     return message
       ? issues.concat(
-          issueParser(message)
+          parser(message)
             .actions.filter(action => isUndefined(action.slug) || action.slug === `${owner}/${repo}`)
             .map(action => ({number: parseInt(action.issue, 10)}))
         )

package/lib/verify.js

@@ -1,4 +1,4 @@
-const {isString, isPlainObject, isUndefined, isArray} = require('lodash');
+const {isString, isPlainObject, isUndefined, isArray, isNumber} = require('lodash');
 const parseGithubUrl = require('parse-github-url');
 const urlJoin = require('url-join');
 const AggregateError = require('aggregate-error');
@@ -11,6 +11,8 @@ const isStringOrStringArray = value => isNonEmptyString(value) || (isArray(value
 const isArrayOf = validator => array => isArray(array) && array.every(value => validator(value));
 
 const VALIDATORS = {
+  proxy: proxy =>
+    isNonEmptyString(proxy) || (isPlainObject(proxy) && isNonEmptyString(proxy.host) && isNumber(proxy.port)),
   assets: isArrayOf(
     asset => isStringOrStringArray(asset) || (isPlainObject(asset) && isStringOrStringArray(asset.path))
   ),
@@ -22,9 +24,9 @@ const VALIDATORS = {
 };
 
 module.exports = async (pluginConfig, {options: {repositoryUrl}, logger}) => {
-  const {githubToken, githubUrl, githubApiPathPrefix, ...options} = resolveConfig(pluginConfig);
+  const {githubToken, githubUrl, githubApiPathPrefix, proxy, ...options} = resolveConfig(pluginConfig);
 
-  const errors = Object.entries(options).reduce(
+  const errors = Object.entries({...options, proxy}).reduce(
     (errors, [option, value]) =>
       !isUndefined(value) && value !== false && !VALIDATORS[option](value)
         ? [...errors, getError(`EINVALID${option.toUpperCase()}`, {[option]: value})]
@@ -41,8 +43,8 @@ module.exports = async (pluginConfig, {options: {repositoryUrl}, logger}) => {
   const {name: repo, owner} = parseGithubUrl(repositoryUrl);
   if (!owner || !repo) {
     errors.push(getError('EINVALIDGITHUBURL'));
-  } else if (githubToken) {
-    const github = getClient({githubToken, githubUrl, githubApiPathPrefix});
+  } else if (githubToken && !errors.find(({code}) => code === 'EINVALIDPROXY')) {
+    const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
 
     try {
       const {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/github",
   "description": "Set of semantic-release plugins for publishing a GitHub release",
-  "version": "4.2.18",
+  "version": "4.4.2",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "bugs": {
     "url": "https://github.com/semantic-release/github/issues"
@@ -21,9 +21,11 @@
     "aggregate-error": "^1.0.0",
     "bottleneck": "^2.0.1",
     "debug": "^3.1.0",
-    "fs-extra": "^6.0.0",
+    "fs-extra": "^7.0.0",
     "globby": "^8.0.0",
-    "issue-parser": "^2.0.0",
+    "http-proxy-agent": "^2.1.0",
+    "https-proxy-agent": "^2.2.1",
+    "issue-parser": "^2.2.0",
     "lodash": "^4.17.4",
     "mime": "^2.0.3",
     "p-filter": "^1.0.0",
@@ -33,14 +35,16 @@
   },
   "devDependencies": {
     "ava": "^0.25.0",
-    "clear-module": "^2.1.0",
+    "clear-module": "^3.0.0",
     "codecov": "^3.0.0",
     "commitizen": "^2.9.6",
     "cz-conventional-changelog": "^2.0.0",
     "nock": "^9.1.0",
     "nyc": "^12.0.1",
+    "proxy": "^0.2.4",
     "proxyquire": "^2.0.0",
     "semantic-release": "^15.0.0",
+    "server-destroy": "^1.0.1",
     "sinon": "^6.0.0",
     "tempy": "^0.2.1",
     "xo": "^0.21.0"