Add ability to run WP-CLI commands over SSH#2327
Merged
Merged
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files
|
mjangda
reviewed
Apr 21, 2025
mjangda
reviewed
Apr 21, 2025
|
|
||
| let countSIGINT = 0; | ||
|
|
||
| if ( ! opts.env.isK8sResident ) { |
Member
There was a problem hiding this comment.
Should we do an explicit check that it's a WP Cloud site?
Contributor
Author
There was a problem hiding this comment.
Co-authored-by: abdullah-kasim <abdullah.kasim@automattic.com>
Co-authored-by: Mohammad Jangda <mo@automattic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
luismulinari
force-pushed
the
wp-cli-command-over-ssh
branch
from
c0055cb to
3ab374e
Compare
mjangda
approved these changes
Apr 23, 2025
Member
mjangda
left a comment
mjangda
left a comment
There was a problem hiding this comment.
Noted some minor things but overall, this looks great.
| @@ -0,0 +1,255 @@ | |||
| /** | |||
Member
There was a problem hiding this comment.
Minor: Should we give this file a more specific name, like wp-ssh.ts?
|
|
||
| debug( "Requesting SSH authentication for command '%s'", command ); | ||
|
|
||
| const sshAuth = await getSSHAuthForCommand( this.app.id, this.env.id, command ); |
Member
There was a problem hiding this comment.
Do we want this in a try-catch to handle failures more gracefully?
| message: 'Error executing command over SSH', | ||
| } ); | ||
|
|
||
| throw new Error( message ); |
Member
There was a problem hiding this comment.
Instead of throwing, should we just be exiting?
Suggested change
| throw new Error( message ); | |
| process.exit( 1 ); |
| if ( ! this.app.id || ! this.env.id ) { | ||
| await this.track( 'error', { | ||
| error: 'no_app_env_id', | ||
| message: 'No app or env ID provided', |
Member
There was a problem hiding this comment.
In src/bin/vip-wp.js, we also include a stripped down version of the command. Should we do that here as well? This can be done in a separate PR.
Co-authored-by: Mohammad Jangda <mo@automattic.com>
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
This PR introduces a new feature for executing WP-CLI commands via SSH instead of using websockets.
Pull request checklist
New release checklist
Steps to Test
npm run buildnode ./dist/bin/vip-wp.js <site> --yes -- user list