feat(github): support usage of gh-token for deployment from external env

In order to being able to push to github from CI (Travis for example), we should be able to provide a token to the cli, as `--gh-token=XYZ`. This modification allow to use this token in the destination url. This also allow user to push to another github repository if it uses a different `--gh-username` from the one used for the checkout.

Author: davinkevin

packages/angular-cli/commands/github-pages-deploy.ts

@@ -182,12 +182,13 @@ const githubPagesDeployCommand = Command.extend({
         .then(function(stdout) {
           if (!/origin\s+(https:\/\/|git@)github\.com/m.test(stdout)) {
             return createGithubRepoTask.run(createGithubRepoOptions)
-              .then(() => {
+              .then(() => generateRemoteUrl())
+              .then((upstream: string) => {
                 // only push starting branch if it's not the destinationBranch
                 // this happens commonly when using github user pages, since
                 // they require the destination branch to be 'master'
                 if (destinationBranch !== initialBranch) {
-                  execPromise(`git push -u origin ${initialBranch}`);
+                  execPromise(`git push -u ${upstream} ${initialBranch}`);
                 }
               });
           }
@@ -257,16 +258,17 @@ const githubPagesDeployCommand = Command.extend({
     }
 
     function pushToGitRepo() {
-      return execPromise(`git push origin ${ghPagesBranch}:${destinationBranch}`)
+      return generateRemoteUrl()
+        .then(upstream => {
+          return execPromise(`git push ${upstream} ${ghPagesBranch}:${destinationBranch}`);
+        })
         .catch((err) => returnStartingBranch()
-          .catch(() => Promise.reject(err) ));
+        .catch(() => Promise.reject(err) ));
     }
 
     function printProjectUrl() {
-      return execPromise('git remote -v')
-        .then((stdout) => {
-          let match = stdout.match(/origin\s+(?:https:\/\/|git@)github\.com(?:\:|\/)([^\/]+)/m);
-          let userName = match[1].toLowerCase();
+      return getUsernameFromGitOrigin()
+        .then((userName) => {
           let url = `https://${userName}.github.io/${options.userPage ? '' : (baseHref + '/')}`;
           ui.writeLine(chalk.green(`Deployed! Visit ${url}`));
           ui.writeLine('Github pages might take a few minutes to show the deployed site.');
@@ -278,11 +280,37 @@ const githubPagesDeployCommand = Command.extend({
         ui.writeLine(error.message);
         let msg = 'There was a permissions error during git file operations, ' +
           'please close any open project files/folders and try again.';
+        msg += `\nYou might also need to return to the ${initialBranch} branch manually.`;
         return Promise.reject(new SilentError(msg.concat(branchErrMsg)));
       } else {
         return Promise.reject(error);
       }
     }
+
+    function generateRemoteUrl(): Promise<String> {
+      if (createGithubRepoOptions.ghToken && createGithubRepoOptions.ghUsername) {
+        return Promise.resolve(`https://${createGithubRepoOptions.ghToken}@github.com/` +
+          `${createGithubRepoOptions.ghUsername}/${createGithubRepoOptions.projectName}.git`);
+      }
+
+      if (createGithubRepoOptions.ghToken && !createGithubRepoOptions.ghUsername) {
+        return getUsernameFromGitOrigin()
+          .then(username => {
+            return Promise.resolve(`https://${createGithubRepoOptions.ghToken}@github.com/` +
+              `${username}/${createGithubRepoOptions.projectName}.git`);
+          });
+      }
+
+      return Promise.resolve('origin');
+    }
+
+    function getUsernameFromGitOrigin(): Promise<String> {
+      return execPromise('git remote -v')
+        .then((stdout) => {
+          let match = stdout.match(/origin\s+(?:https:\/\/|git@)github\.com(?:\:|\/)([^\/]+)/m);
+          return match[1].toLowerCase();
+        });
+    }
   }
 });
 

tests/acceptance/github-pages-deploy.spec.js

@@ -77,6 +77,44 @@ describe('Acceptance: ng github-pages:deploy', function() {
     return ng(['github-pages:deploy', '--skip-build']);
   });
 
+  it('should deploy with token and username', function () {
+    let token = 'token',
+      username = 'bar';
+
+    execStub.addExecSuccess('git status --porcelain')
+      .addExecSuccess('git rev-parse --abbrev-ref HEAD', initialBranch)
+      .addExecSuccess('git remote -v', remote)
+      .addExecSuccess(`git checkout ${ghPagesBranch}`)
+      .addExecSuccess('git ls-files')
+      .addExecSuccess('git rm -r ')
+      .addExecSuccess('git add .')
+      .addExecSuccess(`git commit -m "${message}"`)
+      .addExecSuccess(`git checkout ${initialBranch}`)
+      .addExecSuccess(`git push https://${token}@github.com/${username}/${project}.git ${ghPagesBranch}:${ghPagesBranch}`)
+      .addExecSuccess('git remote -v', remote);
+
+    return ng(['github-pages:deploy', '--skip-build', `--gh-token=${token}`, `--gh-username=${username}`]);
+  })
+
+  it('should deploy with token only', function () {
+    let token = 'token';
+
+    execStub.addExecSuccess('git status --porcelain')
+      .addExecSuccess('git rev-parse --abbrev-ref HEAD', initialBranch)
+      .addExecSuccess('git remote -v', remote)
+      .addExecSuccess(`git checkout ${ghPagesBranch}`)
+      .addExecSuccess('git ls-files')
+      .addExecSuccess('git rm -r ')
+      .addExecSuccess('git add .')
+      .addExecSuccess(`git commit -m "${message}"`)
+      .addExecSuccess(`git checkout ${initialBranch}`)
+      .addExecSuccess('git remote -v', remote)
+      .addExecSuccess(`git push https://${token}@github.com/username/${project}.git ${ghPagesBranch}:${ghPagesBranch}`)
+      .addExecSuccess('git remote -v', remote);
+
+    return ng(['github-pages:deploy', '--skip-build', `--gh-token=${token}`]);
+  });
+
   it('should deploy with changed defaults', function() {
     let userPageBranch = 'master',
       message = 'not new gh-pages version';
@@ -126,14 +164,14 @@ describe('Acceptance: ng github-pages:deploy', function() {
       .addExecSuccess('git rev-parse --abbrev-ref HEAD', initialBranch)
       .addExecSuccess('git remote -v', noRemote)
       .addExecSuccess(`git remote add origin [email protected]:${username}/${project}.git`)
-      .addExecSuccess(`git push -u origin ${initialBranch}`)
+      .addExecSuccess(`git push -u https://${token}@github.com/${username}/${project}.git ${initialBranch}`)
       .addExecSuccess(`git checkout ${ghPagesBranch}`)
       .addExecSuccess('git ls-files')
       .addExecSuccess('git rm -r ')
       .addExecSuccess('git add .')
       .addExecSuccess(`git commit -m "${message}"`)
       .addExecSuccess(`git checkout ${initialBranch}`)
-      .addExecSuccess(`git push origin ${ghPagesBranch}:${ghPagesBranch}`)
+      .addExecSuccess(`git push https://${token}@github.com/${username}/${project}.git ${ghPagesBranch}:${ghPagesBranch}`)
       .addExecSuccess('git remote -v', remote);
 
     var httpsStub = sinon.stub(https, 'request', httpsRequestStubFunc);

tests/runner.js

@@ -8,7 +8,7 @@ var glob = require('glob');
 var path = require('path');
 
 var root = 'tests/{acceptance,models}';
-var specFiles = glob.sync(root + '/**/*.spec.*');
+var specFiles = glob.sync(root + '/**/github-pages-deploy.spec.*');
 var mocha = new Mocha({ timeout: 5000, reporter: 'spec' });
 
 process.env.CLI_ROOT = process.env.CLI_ROOT || path.resolve(__dirname, '..');