Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: optimize clone and checkout in deploy command #5829

Merged
merged 6 commits into from
Nov 11, 2021
Merged

refactor: optimize clone and checkout in deploy command #5829

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b46d1dc
refactor: optimize clone and checkout in deploy command
sivapalan Oct 29, 2021
9217065
refactor: remove obsolete check for default branch and simplify flow
sivapalan Nov 9, 2021
63334e2
refactor: skip cloning repository if deployment branch doesn't exist
sivapalan Nov 9, 2021
cad4907
Merge branch 'main' into optimize_deploy_command_clone_and_checkout
Josh-Cena Nov 11, 2021
405568d
Refactors
Josh-Cena Nov 11, 2021
a2e29b0
More tip about failure
Josh-Cena Nov 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 20 additions & 40 deletions packages/docusaurus/src/commands/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,9 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';
const githubPort = process.env.GITHUB_PORT || siteConfig.githubPort;

let remoteBranch: string;
let deploymentRepoURL: string;
if (useSSH) {
remoteBranch = buildSshUrl(
deploymentRepoURL = buildSshUrl(
githubHost,
organizationName,
projectName,
Expand All @@ -190,7 +190,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
} else {
const gitPass = process.env.GIT_PASS;
const gitCredentials = gitPass ? `${gitUser!}:${gitPass}` : gitUser!;
remoteBranch = buildHttpsUrl(
deploymentRepoURL = buildHttpsUrl(
gitCredentials,
githubHost,
organizationName,
Expand All @@ -200,7 +200,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
}

console.log(
`${chalk.cyan('Remote branch:')} ${obfuscateGitPass(remoteBranch)}`,
`${chalk.cyan('Remote repo URL:')} ${obfuscateGitPass(deploymentRepoURL)}`,
);

// Check if this is a cross-repo publish.
Expand All @@ -225,53 +225,31 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
const toPath = await fs.mkdtemp(
path.join(os.tmpdir(), `${projectName}-${deploymentBranch}`),
);
shell.cd(toPath);

// Check out deployment branch when cloning repository, and then remove all
// the files in the directory. If the 'clone' command fails, assume that
// the deployment branch doesn't exist, and initialize git in an empty
// directory, check out a clean deployment branch and add remote.
if (
shellExecLog(
`git clone --depth 1 --no-single-branch ${remoteBranch} ${toPath}`,
).code !== 0
`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} ${toPath}`,
).code === 0
) {
throw new Error(`Running "git clone" command in "${toPath}" failed.`);
}

shell.cd(toPath);

// If the default branch is the one we're deploying to, then we'll fail
// to create it. This is the case of a cross-repo publish, where we clone
// a github.io repo with a default branch.
const defaultBranch = shell
.exec('git rev-parse --abbrev-ref HEAD')
.stdout.trim();
if (defaultBranch !== deploymentBranch) {
if (shellExecLog(`git checkout origin/${deploymentBranch}`).code !== 0) {
if (
shellExecLog(`git checkout --orphan ${deploymentBranch}`).code !== 0
) {
throw new Error(
`Running "git checkout ${deploymentBranch}" command failed.`,
);
}
} else if (
shellExecLog(`git checkout -b ${deploymentBranch}`).code +
shellExecLog(
`git branch --set-upstream-to=origin/${deploymentBranch}`,
).code !==
0
) {
throw new Error(
`Running "git checkout ${deploymentBranch}" command failed.`,
);
}
shellExecLog('git rm -rf .');
} else {
shellExecLog('git init');
shellExecLog(`git checkout -b ${deploymentBranch}`);
shellExecLog(`git remote add origin ${deploymentRepoURL}`);
}

shellExecLog('git rm -rf .');
try {
await fs.copy(fromPath, toPath);
} catch (error) {
throw new Error(
`Copying build assets from "${fromPath}" to "${toPath}" failed with error "${error}".`,
);
}
shell.cd(toPath);
shellExecLog('git add --all');

const commitMessage =
Expand All @@ -281,7 +259,9 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
if (
shellExecLog(`git push --force origin ${deploymentBranch}`).code !== 0
) {
throw new Error('Running "git push" command failed.');
throw new Error(
'Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?',
);
} else if (commitResults.code === 0) {
// The commit might return a non-zero value when site is up to date.
let websiteURL = '';
Expand Down