3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-22 20:47:53 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix deploy script

Browse source
This commit is contained in:
sebastien 2025-02-28 13:18:04 +01:00
parent 0522307833
commit 3a9f2b6a89
1 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

30
packages/docusaurus/src/commands/deploy.ts
View file

@ -34,6 +34,9 @@ function exec(cmd: string, options?: {log?: boolean; failfast?: boolean}) {
const log = options?.log ?? true; const log = options?.log ?? true;
const failfast = options?.failfast ?? false; const failfast = options?.failfast ?? false;
try { try {
// TODO migrate to execa(file,[...args]) instead
// Use async/await everything
// Avoid execa.command: the args need to be escaped manually
const result = execa.commandSync(cmd); const result = execa.commandSync(cmd);
if (log || debugMode) { if (log || debugMode) {
logger.info`code=${obfuscateGitPass( logger.info`code=${obfuscateGitPass(
@ -60,6 +63,12 @@ In CWD code=${process.cwd()}`,
} }
} }
// Execa escape args and add necessary quotes automatically
// When using Execa.command, the args containing spaces must be escaped manually
function escapeArg(arg: string): string {
return arg.replaceAll(' ', '\\ ');
}
function hasGit() { function hasGit() {
return exec('git --version').exitCode === 0; return exec('git --version').exitCode === 0;
} }
@ -231,15 +240,20 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
// repository default branch. // repository default branch.
if ( if (
exec( exec(
`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`, `git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} ${escapeArg(
toPath,
)}`,
).exitCode !== 0 ).exitCode !== 0
) { ) {
exec(`git clone --depth 1 ${deploymentRepoURL} "${toPath}"`); exec(`git clone --depth 1 ${deploymentRepoURL} ${escapeArg(toPath)}`);
exec(`git checkout -b ${deploymentBranch}`); exec(`git checkout -b ${deploymentBranch}`);
} }
// Clear out any existing contents in the target directory // Clear out any existing contents in the target directory
exec(`git rm -rf ${targetDirectory}`, {log: false, failfast: true}); exec(`git rm -rf ${escapeArg(targetDirectory)}`, {
log: false,
failfast: true,
});
const targetPath = path.join(toPath, targetDirectory); const targetPath = path.join(toPath, targetDirectory);
try { try {
@ -252,18 +266,22 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
const gitUserName = process.env.GIT_USER_NAME; const gitUserName = process.env.GIT_USER_NAME;
if (gitUserName) { if (gitUserName) {
exec(`git config user.name "${gitUserName}"`, {failfast: true}); exec(`git config user.name ${escapeArg(gitUserName)}`, {failfast: true});
} }
const gitUserEmail = process.env.GIT_USER_EMAIL; const gitUserEmail = process.env.GIT_USER_EMAIL;
if (gitUserEmail) { if (gitUserEmail) {
exec(`git config user.email "${gitUserEmail}"`, {failfast: true}); exec(`git config user.email ${escapeArg(gitUserEmail)}`, {
failfast: true,
});
} }
const commitMessage = const commitMessage =
process.env.CUSTOM_COMMIT_MESSAGE ?? process.env.CUSTOM_COMMIT_MESSAGE ??
`Deploy website - based on ${currentCommit}`; `Deploy website - based on ${currentCommit}`;
const commitResults = exec(`git commit -m "${commitMessage}"`); const commitResults = exec(
`git commit -m ${escapeArg(commitMessage)} --allow-empty`,
);
if (exec(`git push --force origin ${deploymentBranch}`).exitCode !== 0) { if (exec(`git push --force origin ${deploymentBranch}`).exitCode !== 0) {
throw new Error( throw new Error(
'Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?', 'Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?',