-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
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.
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
refactor(v2): enhance CLI experience #2556
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,12 +19,12 @@ export async function deploy( | |
): Promise<void> { | ||
console.log('Deploy command invoked ...'); | ||
if (!shell.which('git')) { | ||
throw new Error('Sorry, this script requires git'); | ||
throw new Error('Git not installed or on the PATH!'); | ||
} | ||
|
||
const gitUser = process.env.GIT_USER; | ||
if (!gitUser) { | ||
throw new Error(`Please set the GIT_USER`); | ||
throw new Error('Please set the GIT_USER environment variable!'); | ||
} | ||
|
||
// The branch that contains the latest docs changes that will be deployed. | ||
|
@@ -85,7 +85,8 @@ export async function deploy( | |
// We don't allow deploying to the same branch unless it's a cross publish. | ||
if (currentBranch === deploymentBranch && !crossRepoPublish) { | ||
throw new Error( | ||
`Cannot deploy from a ${deploymentBranch} branch. Only to it`, | ||
`You cannot deploy from this branch (${currentBranch}).` + | ||
'\nYou will need to checkout to a different branch!', | ||
); | ||
} | ||
|
||
|
@@ -158,21 +159,28 @@ export async function deploy( | |
|
||
const commitMessage = | ||
process.env.CUSTOM_COMMIT_MESSAGE || | ||
`Deploy website version based on ${currentCommit}`; | ||
`Deploy website - based on ${currentCommit}`; | ||
const commitResults = shell.exec(`git commit -m "${commitMessage}"`); | ||
if ( | ||
shell.exec(`git push --force origin ${deploymentBranch}`).code !== 0 | ||
) { | ||
throw new Error('Error: Git push failed'); | ||
} else if (commitResults.code === 0) { | ||
// The commit might return a non-zero value when site is up to date. | ||
const websiteURL = | ||
githubHost === 'github.com' | ||
? // gh-pages hosted repo | ||
`https://${organizationName}.github.io/${projectName}` | ||
: // GitHub enterprise hosting. | ||
`https://${githubHost}/pages/${organizationName}/${projectName}`; | ||
shell.echo(`Website is live at: ${websiteURL}`); | ||
let websiteURL = ''; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm going to revert this section since it's not a trivial change. You can submit a new PR just for these changes. |
||
if (githubHost === 'github.com') { | ||
// github.io hosting | ||
if (projectName.includes('.github.io')) { | ||
// domain root gh-pages hosted repo | ||
websiteURL = `https://${organizationName}.github.io/`; | ||
} else { | ||
websiteURL = `https://${organizationName}.github.io/${projectName}/`; | ||
} | ||
} else { | ||
// GitHub enterprise hosting. | ||
websiteURL = `https://${githubHost}/pages/${organizationName}/${projectName}/`; | ||
} | ||
shell.echo(`Website is live at ${websiteURL}`); | ||
shell.exit(0); | ||
} | ||
}); | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should retain the boolean values here as it's much easier for the user to know what value to use. Could you change them back?