Fixing some mistakes

Documenting Adding githubPort documentation on docusaurus.config.js. Addind SSH protocol prefix. ssh:// Using the default protocol port instead of define it on the code. Prettify.
facebook · Apr 1, 2021 · cc3971d · cc3971d
1 parent daf33fd
commit cc3971d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 8 deletions.
diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts
@@ -34,6 +34,7 @@ export interface DocusaurusConfig {
   organizationName?: string;
   projectName?: string;
   githubHost?: string;
+  githubPort?: string;
   plugins?: PluginConfig[];
   themes?: PluginConfig[];
   presets?: PresetConfig[];

diff --git a/packages/docusaurus/src/commands/deploy.ts b/packages/docusaurus/src/commands/deploy.ts
@@ -97,22 +97,23 @@ export default async function deploy(
     (projectName.indexOf('.github.io') !== -1 ? 'master' : 'gh-pages');
   console.log(`${chalk.cyan('deploymentBranch:')} ${deploymentBranch}`);
 
+  const useSSH = process.env.USE_SSH;
+
   const githubHost =
     process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';
-  const githubPort =
-    process.env.GITHUB_PORT || siteConfig.githubPort || (useSSH && useSSH.toLowerCase() === 'true'
-      ? '22'
-      : '433');
-
-  const useSSH = process.env.USE_SSH;
+  const githubPort = process.env.GITHUB_PORT || siteConfig.githubPort;
+
   const gitPass: string | undefined = process.env.GIT_PASS;
   let gitCredentials = `${gitUser}`;
   if (gitPass) {
     gitCredentials = `${gitCredentials}:${gitPass}`;
   }
 
-  const sshRemoteBranch: string = `git@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
-  const nonSshRemoteBranch: string = `https://${gitCredentials}@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
+  const githubAddress = `${githubHost}${githubPort ? ':' + githubPort : ''}`;
+  const githubPath = `${organizationName}/${projectName}`;
+
+  const sshRemoteBranch: string = `ssh://git@${githubAddress}/${githubPath}.git`;
+  const nonSshRemoteBranch: string = `https://${gitCredentials}@${githubAddress}/${githubPath}.git`;
 
   const remoteBranch =
     useSSH && useSSH.toLowerCase() === 'true'

diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md
@@ -204,6 +204,18 @@ module.exports = {
 };
 ```
 
+### `githubPort` {#githubPort}
+
+- Type: `string`
+
+The port of your server. Useful if you are using GitHub Enterprise.
+
+```js title="docusaurus.config.js"
+module.exports = {
+  githubPort: '22',
+};
+```
+
 ### `themeConfig` {#themeconfig}
 
 - Type: `Object`

diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx
@@ -99,6 +99,7 @@ GitHub enterprise installations should work in the same manner as github.com; yo
 | Name          | Description                                     |
 | ------------- | ----------------------------------------------- |
 | `GITHUB_HOST` | The domain name of your GitHub enterprise site. |
+| `GITHUB_PORT` | The port of your GitHub enterprise site.        |
 
 ### Deploy {#deploy}