WIP just debugging nevermind me

*Total -- 258.67kb -> 182.47kb (29.46%)

/media/semantic-release-cli.png -- 116.80kb -> 65.42kb (43.99%)
/media/bender.png -- 141.88kb -> 117.05kb (17.5%)

README.md

@@ -17,11 +17,6 @@
     <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
   </a>
 </p>
-<p align="center">
-  <a href="https://waffle.io/semantic-release/semantic-release">
-    <img alt="Waffle.io" src="https://badge.waffle.io/semantic-release/semantic-release.svg?columns=all">
-  </a>
-</p>
 <p align="center">
   <a href="https://www.npmjs.com/package/semantic-release">
     <img alt="npm latest version" src="https://img.shields.io/npm/v/semantic-release/latest.svg">
@@ -57,7 +52,7 @@ This removes the immediate connection between human emotions and version numbers
 
 By default **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). The commit message format can be changed with the [`preset` or `config` options](docs/usage/configuration.md#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
 
-Tools such as [commitizen](https://github.com/commitizen/cz-cli), [commitlint](https://github.com/marionebl/commitlint) or [semantic-git-commit-cli](https://github.com/JPeer264/node-semantic-git-commit-cli) can be used to help contributors and enforce valid commit messages.
+Tools such as [commitizen](https://github.com/commitizen/cz-cli), [commitlint](https://github.com/conventional-changelog/commitlint) or [semantic-git-commit-cli](https://github.com/JPeer264/node-semantic-git-commit-cli) can be used to help contributors and enforce valid commit messages.
 
 Here is an example of the release type that will be done based on a commit messages:
 

docs/developer-guide/js-api.md

@@ -39,7 +39,7 @@ try {
     }
 
     for (const release of releases) {
-      console.log(`The release was published with plugin "${pluginName}".`);
+      console.log(`The release was published with plugin "${release.pluginName}".`);
     }
   } else {
     console.log('No release published.');

docs/extending/plugins-list.md

@@ -2,15 +2,19 @@
 
 ## Official plugins
 - [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `analyzeCommits`: Determine the type of release by analyzing commits with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
 - [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `generateNotes`: Generate release notes for the commits added since the last release with [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
 - [@semantic-release/github](https://github.com/semantic-release/github)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `verifyConditions`: Verify the presence and the validity of the GitHub authentication and release configuration
   - `publish`: Publish a [GitHub release](https://help.github.com/articles/about-releases)
   - `success`: Add a comment to GitHub issues and pull requests resolved in the release
   - `fail`: Open a GitHub issue when a release fails
 - [@semantic-release/npm](https://github.com/semantic-release/npm)
+  - **Note**: this is already part of semantic-release and does not have to be installed separately
   - `verifyConditions`: Verify the presence and the validity of the npm authentication and release configuration
   - `prepare`: Update the package.json version and create the npm package tarball
   - `publish`: Publish the package on the npm registry
@@ -41,6 +45,10 @@
 
 [Open a Pull Request](https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md#submitting-a-pull-request) to add your plugin to the list.
 
+- [semantic-release-slack-bot](https://github.com/juliuscc/semantic-release-slack-bot)
+  - `verifyConditions`: Verify that the environment variable `SLACK_WEBHOOK` has been defined.
+  - `success`: Publish a message about the success to a slack channel.
+  - `fail`: Optionally publish a message about failure to a slack channel.
 - [semantic-release-docker](https://github.com/felixfbecker/semantic-release-docker)
   - `verifyConditions`: Verify that all needed configuration is present and login to the Docker registry.
   - `publish`: Tag the image specified by `name` with the new version, push it to Docker Hub and update the latest tag
@@ -72,4 +80,14 @@
   - `prepare`: Changes the version number in the `pom.xml` (or all `pom.xml` files in maven projects with multiple `pom.xml` files) and optionally creates a commit with this version number and pushes it to `master`
   - `publish`: Runs `mvn deploy` to deploy to maven central and optionally will update to next snapshot version and merge changes to development branch
 - [semantic-release-ado](https://github.com/lluchmk/semantic-release-ado)
-  - `prepare`: Stores the version number as an Azure DevOps pipeline variable availabe to downstream steps on the job
+  - `prepare`: Stores the version number as an Azure DevOps pipeline variable availabe to downstream steps on the job
+- [gradle-semantic-release](https://github.com/KengoTODA/gradle-semantic-release-plugin)
+  - `verifyConditions`: Verify that project has a Gradle wrapper script, and `build.gradle` contains a task to publish artifacts.
+  - `prepare`: Changes the version number in the `gradle.properties`
+  - `publish`: Triggers Gradle to publish artifacts.
+- [semantic-release-circleci-orb](https://github.com/matt-oakes/semantic-release-circleci-orb)
+  - `verifyConditions`: Verify the presence of the `CIRCLECI_API_TOKEN` environment variable, `orbName` option, and the `circleci` CLI.
+  - `publish`: Publish the CircleCI orb.
+- [semantic-release-github-pages](https://github.com/qiwi/semantic-release-gh-pages-plugin)
+  - `verifyConditions`: Verify the presence of the auth token set via environment variables.
+  - `publish`: Pushes commit to the documentation branch.

docs/recipes/git-auth-ssh-keys.md

@@ -137,7 +137,7 @@ jobs:
           # Make sure only the current user can read the private key
           - chmod 600 /tmp/git_deploy_key
           # Create a script to return the passphrase environment variable to ssh-add
-          - echo 'echo ${SSH_PASSPHRASE}' > /tmp/askpass && chmod +x /tmp/askpass
+          - echo 'echo ${SSL_PASSPHRASE}' > /tmp/askpass && chmod +x /tmp/askpass
           # Start the authentication agent
           - eval "$(ssh-agent -s)"
           # Add the key to the authentication agent

docs/usage/getting-started.md

@@ -1,6 +1,6 @@
 # Getting started
 
-In order to use **semantic-release** you must follows this steps:
+In order to use **semantic-release** you must follow these steps:
 - [Install](./installation.md#installation) **semantic-release** in your project
 - Configure your Continuous Integration service to [run **semantic-release**](./ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
 - Configure your Git repository and package manager repository [authentication](ci-configuration.md#authentication) in your Continuous Integration service
@@ -19,4 +19,4 @@ semantic-release-cli setup
 
 See the [semantic-release-cli](https://github.com/semantic-release/cli#what-it-does) documentation for more details.
 
-**Note**: only a limited number of options, CI services and plugins is currently supported by `semantic-release-cli`.
+**Note**: only a limited number of options, CI services and plugins are currently supported by `semantic-release-cli`.

docs/usage/plugins.md

@@ -17,15 +17,26 @@ A plugin is a npm module that can implement one or more of the following steps:
 
 **Note:** If no plugin with a `analyzeCommits` step is defined `@semantic-release/commit-analyzer` will be used.
 
-See [available plugins](../extending/plugins-list.md).
+## Plugins installation
+
+These five plugins are already part of **semantic-release** and don't have to be installed separately:
+```
+"@semantic-release/commit-analyzer"	
+"@semantic-release/error"	
+"@semantic-release/github"	
+"@semantic-release/npm"	
+"@semantic-release/release-notes-generator"
+```
+
+[Additional plugins](../extending/plugins-list.md) have to be installed via npm:
+
+```bash
+$ npm install @semantic-release/git @semantic-release/changelog -D
+```
 
 ## Plugins configuration
 
-Each plugin must be installed and configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name.
-
-```bash
-$ npm install @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/npm -D
-```
+Each plugin must be configured with the [`plugins` options](./configuration.md#plugins) by specifying the list of plugins by npm module name.
 
 ```json
 {

lib/get-config.js

@@ -85,6 +85,6 @@ module.exports = async (context, opts) => {
 };
 
 async function pkgRepoUrl(opts) {
-  const {pkg} = await readPkgUp(opts);
+  const {package: pkg} = (await readPkgUp(opts)) || {};
   return pkg && (isPlainObject(pkg.repository) ? pkg.repository.url : pkg.repository);
 }

lib/get-git-auth-url.js

@@ -3,16 +3,6 @@ const {isNil} = require('lodash');
 const hostedGitInfo = require('hosted-git-info');
 const {verifyAuth} = require('./git');
 
-const GIT_TOKENS = {
-  GIT_CREDENTIALS: undefined,
-  GH_TOKEN: undefined,
-  GITHUB_TOKEN: undefined,
-  GL_TOKEN: 'gitlab-ci-token:',
-  GITLAB_TOKEN: 'gitlab-ci-token:',
-  BB_TOKEN: 'x-token-auth:',
-  BITBUCKET_TOKEN: 'x-token-auth:',
-};
-
 /**
  * Determine the the git repository URL to use to push, either:
  * - The `repositoryUrl` as is if allowed to push
@@ -25,6 +15,18 @@ const GIT_TOKENS = {
  * @return {String} The formatted Git repository URL.
  */
 module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
+  const GIT_TOKENS = {
+    GIT_CREDENTIALS: undefined,
+    GH_TOKEN: undefined,
+    // GitHub Actions require the "x-access-token:" prefix for git access
+    // https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation
+    GITHUB_TOKEN: isNil(env.GITHUB_ACTION) ? undefined : 'x-access-token:',
+    GL_TOKEN: 'gitlab-ci-token:',
+    GITLAB_TOKEN: 'gitlab-ci-token:',
+    BB_TOKEN: 'x-token-auth:',
+    BITBUCKET_TOKEN: 'x-token-auth:',
+  };
+
   const info = hostedGitInfo.fromUrl(repositoryUrl, {noGitPlus: true});
   const {protocol, ...parsed} = parse(repositoryUrl);
 
@@ -43,6 +45,13 @@ module.exports = async ({cwd, env, options: {repositoryUrl, branch}}) => {
     const envVar = Object.keys(GIT_TOKENS).find(envVar => !isNil(env[envVar]));
     const gitCredentials = `${GIT_TOKENS[envVar] || ''}${env[envVar] || ''}`;
 
+    console.log(`-------- envVar -------- `);
+    console.log(envVar);
+    console.log(`-------- GIT_TOKENS[envVar] -------- `);
+    console.log(GIT_TOKENS[envVar]);
+    console.log(`-------- env[envVar].substr(5) -------- `);
+    console.log((env[envVar] || '').substr(5));
+
     if (gitCredentials) {
       // If credentials are set via environment variables, convert the URL to http/https and add basic auth, otherwise return `repositoryUrl` as is
       const [match, auth, host, path] = /^(?!.+:\/\/)(?:(.*)@)?(.*?):(.*)$/.exec(repositoryUrl) || [];

package.json

@@ -24,48 +24,48 @@
     "@semantic-release/github": "^5.1.0",
     "@semantic-release/npm": "^5.0.5",
     "@semantic-release/release-notes-generator": "^7.1.2",
-    "aggregate-error": "^2.0.0",
+    "aggregate-error": "^3.0.0",
     "cosmiconfig": "^5.0.1",
     "debug": "^4.0.0",
     "env-ci": "^3.0.0",
     "execa": "^1.0.0",
-    "figures": "^2.0.0",
+    "figures": "^3.0.0",
     "find-versions": "^3.0.0",
-    "get-stream": "^4.0.0",
+    "get-stream": "^5.0.0",
     "git-log-parser": "^1.2.0",
-    "hook-std": "^1.1.0",
+    "hook-std": "^2.0.0",
     "hosted-git-info": "^2.7.1",
     "lodash": "^4.17.4",
     "marked": "^0.6.0",
     "marked-terminal": "^3.2.0",
-    "p-locate": "^3.0.0",
-    "p-reduce": "^1.0.0",
-    "read-pkg-up": "^4.0.0",
-    "resolve-from": "^4.0.0",
-    "semver": "^5.4.1",
+    "p-locate": "^4.0.0",
+    "p-reduce": "^2.0.0",
+    "read-pkg-up": "^6.0.0",
+    "resolve-from": "^5.0.0",
+    "semver": "^6.0.0",
     "signale": "^1.2.1",
     "yargs": "^13.1.0"
   },
   "devDependencies": {
-    "ava": "^1.0.1",
+    "ava": "^1.3.1",
     "clear-module": "^3.0.0",
     "codecov": "^3.0.0",
     "commitizen": "^3.0.0",
     "cz-conventional-changelog": "^2.0.0",
     "delay": "^4.0.0",
     "dockerode": "^2.5.2",
-    "file-url": "^2.0.2",
-    "fs-extra": "^7.0.0",
+    "file-url": "^3.0.0",
+    "fs-extra": "^8.0.0",
     "got": "^9.0.0",
     "js-yaml": "^3.10.0",
     "mockserver-client": "^5.1.1",
     "nock": "^10.0.0",
-    "nyc": "^13.1.0",
-    "p-retry": "^3.0.0",
+    "nyc": "^14.0.0",
+    "p-retry": "^4.0.0",
     "proxyquire": "^2.0.0",
-    "sinon": "^7.1.1",
+    "sinon": "^7.2.7",
     "stream-buffers": "^3.0.2",
-    "tempy": "^0.2.1",
+    "tempy": "^0.3.0",
     "xo": "^0.24.0"
   },
   "engines": {

test/get-git-auth-url.test.js

@@ -244,6 +244,19 @@ test('Return the "https" formatted URL if "gitCredentials" is defined with "BITB
   );
 });
 
+test('Return the "https" formatted URL if "GITHUB_ACTION" is set', async t => {
+  const {cwd} = await gitRepo();
+
+  t.is(
+    await getAuthUrl({
+      cwd,
+      env: {...env, GITHUB_ACTION: 'foo', GITHUB_TOKEN: 'token'},
+      options: {branch: 'master', repositoryUrl: 'git@host.null:owner/repo.git'},
+    }),
+    'https://x-access-token:token@host.null/owner/repo.git'
+  );
+});
+
 test('Handle "https" URL with group and subgroup, with "GIT_CREDENTIALS"', async t => {
   const {cwd} = await gitRepo();
 

test/index.test.js

@@ -169,7 +169,7 @@ test('Plugins are called with expected values', async t => {
   t.deepEqual(success.args[0][1].commits[0].message, commits[0].message);
   t.deepEqual(success.args[0][1].nextRelease, {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`});
   t.deepEqual(success.args[0][1].releases, [
-    {...release1, ...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: '[Function: proxy]'},
+    {...release1, ...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: '[Function: functionStub]'},
     {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: pluginNoop},
   ]);
 
@@ -178,7 +178,12 @@ test('Plugins are called with expected values', async t => {
     commits: [commits[0]],
     nextRelease: {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`},
     releases: [
-      {...release1, ...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: '[Function: proxy]'},
+      {
+        ...release1,
+        ...nextRelease,
+        notes: `${notes1}\n\n${notes2}\n\n${notes3}`,
+        pluginName: '[Function: functionStub]',
+      },
       {...nextRelease, notes: `${notes1}\n\n${notes2}\n\n${notes3}`, pluginName: pluginNoop},
     ],
   });
@@ -342,10 +347,14 @@ test('Call all "success" plugins even if one errors out', async t => {
   );
 
   t.is(success1.callCount, 1);
-  t.deepEqual(success1.args[0][1].releases, [{...release, ...nextRelease, notes, pluginName: '[Function: proxy]'}]);
+  t.deepEqual(success1.args[0][1].releases, [
+    {...release, ...nextRelease, notes, pluginName: '[Function: functionStub]'},
+  ]);
 
   t.is(success2.callCount, 1);
-  t.deepEqual(success2.args[0][1].releases, [{...release, ...nextRelease, notes, pluginName: '[Function: proxy]'}]);
+  t.deepEqual(success2.args[0][1].releases, [
+    {...release, ...nextRelease, notes, pluginName: '[Function: functionStub]'},
+  ]);
 });
 
 test('Log all "verifyConditions" errors', async t => {
@@ -757,7 +766,7 @@ test('Accept "undefined" value returned by "generateNotes" and "false" by "publi
   t.is(publish.args[0][1].nextRelease.notes, notes2);
 
   t.is(success.callCount, 1);
-  t.deepEqual(success.args[0][1].releases, [{pluginName: '[Function: proxy]'}]);
+  t.deepEqual(success.args[0][1].releases, [{pluginName: '[Function: functionStub]'}]);
 });
 
 test('Returns false if triggered by a PR', async t => {