feat: Add GHES support 🏢 (#580)

Changes for #579

Co-authored-by: dom <dominik.meyer01@sap.com>

.gitignore

@@ -4,3 +4,4 @@ coverage
 .eslintcache
 .env
 node_modules
+.husky/_

README.md

@@ -57,7 +57,11 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
 
 2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87)
 
+### GitHub Enterprise Server Support
 
+✅️ GitHub Enterprise Server is supported above `2.22.6`.
+
+Note that the `GITHUB_TOKEN` that is created by the runner might not inherently have push/publish privileges on GHES. You might need to create/request a technical user with write permissions to your target repository.
 
 ## Table of Contents
 

__tests__/set-tokens.ghes.test.ts

@@ -0,0 +1,37 @@
+import {setPersonalToken, setGithubToken} from '../src/set-tokens';
+
+const OLD_ENV = process.env;
+
+beforeEach(() => {
+  jest.resetModules();
+  process.env = {...OLD_ENV};
+});
+
+afterAll(() => {
+  process.env = OLD_ENV; // Restore old environment
+});
+
+describe('setGithubToken()', () => {
+  test('return remote url with GITHUB_TOKEN gh-pages', () => {
+    process.env.GITHUB_SERVER_URL = 'https://github.enterprise.server';
+    const expected = 'https://x-access-token:GITHUB_TOKEN@github.enterprise.server/owner/repo.git';
+    const test = setGithubToken(
+      'GITHUB_TOKEN',
+      'owner/repo',
+      'gh-pages',
+      '',
+      'refs/heads/master',
+      'push'
+    );
+    expect(test).toMatch(expected);
+  });
+});
+
+describe('setPersonalToken()', () => {
+  test('return remote url with personal access token', () => {
+    process.env.GITHUB_SERVER_URL = 'https://github.enterprise.server';
+    const expected = 'https://x-access-token:pat@github.enterprise.server/owner/repo.git';
+    const test = setPersonalToken('pat', 'owner/repo');
+    expect(test).toMatch(expected);
+  });
+});

lib/exec-child.js

@@ -0,0 +1 @@
+module.exports=(()=>{var e={607:(e,r,t)=>{e=t.nmd(e);if(require.main!==e){throw new Error("This file should not be required")}var i=t(129);var s=t(747);var a=process.argv[2];var d=s.readFileSync(a,"utf8");var o=JSON.parse(d);var p=o.command;var _=o.execOptions;var c=o.pipe;var u=o.stdoutFile;var n=o.stderrFile;var l=i.exec(p,_,function(e){if(!e){process.exitCode=0}else if(e.code===undefined){process.exitCode=1}else{process.exitCode=e.code}});var v=s.createWriteStream(u);var f=s.createWriteStream(n);l.stdout.pipe(v);l.stderr.pipe(f);l.stdout.pipe(process.stdout);l.stderr.pipe(process.stderr);if(c){l.stdin.end(c)}},129:e=>{"use strict";e.exports=require("child_process")},747:e=>{"use strict";e.exports=require("fs")}};var r={};function __nccwpck_require__(t){if(r[t]){return r[t].exports}var i=r[t]={id:t,loaded:false,exports:{}};var s=true;try{e[t](i,i.exports,__nccwpck_require__);s=false}finally{if(s)delete r[t]}i.loaded=true;return i.exports}(()=>{__nccwpck_require__.nmd=(e=>{e.paths=[];if(!e.children)e.children=[];return e})})();__nccwpck_require__.ab=__dirname+"/";return __nccwpck_require__(607)})();

lib/index.js

@@ -0,0 +1 @@
+module.exports=(()=>{var __webpack_modules__={7351:function(e,t,r){"use strict";var n=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(e!=null)for(var r in e)if(Object.hasOwnProperty.call(e,r))t[r]=e[r];t["default"]=e;return t};Object.defineProperty(t,"__esModule",{value:true});const s=n(r(2087));const o=r(5278);function issueCommand(e,t,r){const n=new Command(e,t,r);process.stdout.write(n.toString()+s.EOL)}t.issueCommand=issueCommand;function issue(e,t=""){issueCommand(e,{},t)}t.issue=issue;const i="::";class Command{constructor(e,t,r){if(!e){e="missing.command"}this.command=e;this.properties=t;this.message=r}toString(){let e=i+this.command;if(this.properties&&Object.keys(this.properties).length>0){e+=" ";let t=true;for(const r in this.properties){if(this.properties.hasOwnProperty(r)){const n=this.properties[r];if(n){if(t){t=false}else{e+=","}e+=`${r}=${escapeProperty(n)}`}}}}e+=`${i}${escapeData(this.message)}`;return e}}function escapeData(e){return o.toCommandValue(e).replace(/%/g,"%25").replace(/\r/g,"%0D").replace(/\n/g,"%0A")}function escapeProperty(e){return o.toCommandValue(e).replace(/%/g,"%25").replace(/\r/g,"%0D").replace(/\n/g,"%0A").replace(/:/g,"%3A").replace(/,/g,"%2C")}},2186:function(e,t,r){"use strict";var n=this&&this.__awaiter||function(e,t,r,n){function adopt(e){return e instanceof r?e:new r(function(t){t(e)})}return new(r||(r=Promise))(function(r,s){function fulfilled(e){try{step(n.next(e))}catch(e){s(e)}}function rejected(e){try{step(n["throw"](e))}catch(e){s(e)}}function step(e){e.done?r(e.value):adopt(e.value).then(fulfilled,rejected)}step((n=n.apply(e,t||[])).next())})};var s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(e!=null)for(var r in e)if(Object.hasOwnProperty.call(e,r))t[r]=e[r];t["default"]=e;return t};Object.defineProperty(t,"__esModule",{value:true});const o=r(7351);const i=r(717);const a=r(5278);const c=s(r(2087));const u=s(r(5622));var l;(function(e){e[e["Success"]=0]="Success";e[e["Failure"]=1]="Failure"})(l=t.ExitCode||(t.ExitCode={}));function exportVariable(e,t){const r=a.toCommandValue(t);process.env[e]=r;const n=process.env["GITHUB_ENV"]||"";if(n){const t="_GitHubActionsFileCommandDelimeter_";const n=`${e}<<${t}${c.EOL}${r}${c.EOL}${t}`;i.issueCommand("ENV",n)}else{o.issueCommand("set-env",{name:e},r)}}t.exportVariable=exportVariable;function setSecret(e){o.issueCommand("add-mask",{},e)}t.setSecret=setSecret;function addPath(e){const t=process.env["GITHUB_PATH"]||"";if(t){i.issueCommand("PATH",e)}else{o.issueCommand("add-path",{},e)}process.env["PATH"]=`${e}${u.delimiter}${process.env["PATH"]}`}t.addPath=addPath;function getInput(e,t){const r=process.env[`INPUT_${e.replace(/ /g,"_").toUpperCase()}`]||"";if(t&&t.required&&!r){throw new Error(`Input required and not supplied: ${e}`)}return r.trim()}t.getInput=getInput;function setOutput(e,t){o.issueCommand("set-output",{name:e},t)}t.setOutput=setOutput;function setCommandEcho(e){o.issue("echo",e?"on":"off")}t.setCommandEcho=setCommandEcho;function setFailed(e){process.exitCode=l.Failure;error(e)}t.setFailed=setFailed;function isDebug(){return process.env["RUNNER_DEBUG"]==="1"}t.isDebug=isDebug;function debug(e){o.issueCommand("debug",{},e)}t.debug=debug;function error(e){o.issue("error",e instanceof Error?e.toString():e)}t.error=error;function warning(e){o.issue("warning",e instanceof Error?e.toString():e)}t.warning=warning;function info(e){process.stdout.write(e+c.EOL)}t.info=info;function startGroup(e){o.issue("group",e)}t.startGroup=startGroup;function endGroup(){o.issue("endgroup")}t.endGroup=endGroup;function group(e,t){return n(this,void 0,void 0,function*(){startGroup(e);let r;try{r=yield t()}finally{endGroup()}return r})}t.group=group;function saveState(e,t){o.issueCommand("save-state",{name:e},t)}t.saveState=saveState;function getState(e){return process.env[`STATE_${e}`]||""}t.getState=getState},717:function(e,t,r){"use strict";var n=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(e!=null)for(var r in e)if(Object.hasOwnProperty.call(e,r))t[r]=e[r];t["default"]=e;return t};Object.defineProperty(t,"__esModule",{value:true});const s=n(r(5747));const o=n(r(2087));const i=r(5278);function issueCommand(e,t){const r=process.env[`GITHUB_${e}`];if(!r){throw new Error(`Unable to find environment variable for file command ${e}`)}if(!s.existsSync(r)){throw new Error(`Missing file at path: ${r}`)}s.appendFileSync(r,`${i.toCommandValue(t)}${o.EOL}`,{encoding:"utf8"})}t.issueCommand=issueCommand},5278:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:true});function toCommandValue(e){if(e===null||e===undefined){return""}else if(typeof e==="string"||e instanceof String){return e}return JSON.stringify(e)}t.toCommandValue=toCommandValue},1514:function(e,t,r){"use strict";var n=this&&this.__awaiter||function(e,t,r,n){function adopt(e){return e instanceof r?e:new r(function(t){t(e)})}return new(r||(r=Promise))(function(r,Line truncated

package-lock.json

@@ -7,6 +7,7 @@
     "": {
       "name": "actions-github-pages",
       "version": "3.7.3",
+      "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.2.6",

src/git-utils.ts

@@ -3,6 +3,7 @@ import * as exec from '@actions/exec';
 import * as glob from '@actions/glob';
 import path from 'path';
 import fs from 'fs';
+import {URL} from 'url';
 import {Inputs, CmdResult} from './interfaces';
 import {createDir} from './utils';
 import {cp, rm} from 'shelljs';
@@ -13,6 +14,10 @@ export async function createBranchForce(branch: string): Promise<void> {
   return;
 }
 
+export function getServerUrl(): URL {
+  return new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
+}
+
 export async function deleteExcludedAssets(destDir: string, excludeAssets: string): Promise<void> {
   if (excludeAssets === '') return;
   core.info(`[INFO] delete excluded assets`);

src/set-tokens.ts

@@ -10,6 +10,7 @@ const cpSpawnSync = require('child_process').spawnSync;
 const cpexec = require('child_process').execFileSync;
 import {Inputs} from './interfaces';
 import {getHomeDir} from './utils';
+import {getServerUrl} from './git-utils';
 
 export async function setSSHKey(inps: Inputs, publishRepo: string): Promise<string> {
   core.info('[INFO] setup SSH deploy key');
@@ -20,10 +21,12 @@ export async function setSSHKey(inps: Inputs, publishRepo: string): Promise<stri
   await exec.exec('chmod', ['700', sshDir]);
 
   const knownHosts = path.join(sshDir, 'known_hosts');
-  // ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts on Ubuntu
+  // ssh-keyscan -t rsa github.com or serverUrl >> ~/.ssh/known_hosts on Ubuntu
   const cmdSSHkeyscanOutput = `\
-# github.com:22 SSH-2.0-babeld-1f0633a6
-github.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==
+# ${getServerUrl().host}.com:22 SSH-2.0-babeld-1f0633a6
+${
+  getServerUrl().host
+} ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==
 `;
   fs.writeFileSync(knownHosts, cmdSSHkeyscanOutput + '\n');
   core.info(`[INFO] wrote ${knownHosts}`);
@@ -36,8 +39,8 @@ github.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXY
 
   const sshConfigPath = path.join(sshDir, 'config');
   const sshConfigContent = `\
-Host github
-    HostName github.com
+Host ${getServerUrl().host}
+    HostName ${getServerUrl().host}
     IdentityFile ~/.ssh/github
     User git
 `;
@@ -60,7 +63,7 @@ Watch https://github.com/peaceiris/actions-gh-pages/issues/87
   core.exportVariable('SSH_AUTH_SOCK', '/tmp/ssh-auth.sock');
   await exec.exec('ssh-add', [idRSA]);
 
-  return `git@github.com:${publishRepo}.git`;
+  return `git@${getServerUrl().host}:${publishRepo}.git`;
 }
 
 export function setGithubToken(
@@ -94,12 +97,12 @@ This operation is prohibited to protect your contents
     }
   }
 
-  return `https://x-access-token:${githubToken}@github.com/${publishRepo}.git`;
+  return `https://x-access-token:${githubToken}@${getServerUrl().host}/${publishRepo}.git`;
 }
 
 export function setPersonalToken(personalToken: string, publishRepo: string): string {
   core.info('[INFO] setup personal access token');
-  return `https://x-access-token:${personalToken}@github.com/${publishRepo}.git`;
+  return `https://x-access-token:${personalToken}@${getServerUrl().host}/${publishRepo}.git`;
 }
 
 export function getPublishRepo(externalRepository: string, owner: string, repo: string): string {