Blueprints: Add ifAlreadyInstalled to installPlugin and installTheme steps #1244
Conversation
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
…steps Adds an `ifAlreadyInstalled?: 'overwrite' | 'skip' | 'error'` option to installPlugin and installTheme steps. It defaults to `overwrite`. Installing a plugin or theme over a currently installed one is a common gotcha. Currently it results in an error and blocks the Blueprint execution. This behavior is, however, often undesirable as it prevents having a single Blueprint that installs a twentytwentyfour theme on different versions of WordPress. An addition of the `ifAlreadyInstalled` option puts the Blueprint author in control and provides a sensible default behavior where the installation will "just work" by replacing the already installed version of the plugin or theme. ## Testing instructions Confirm the unit tests pass
adamziel
added
[Type] Enhancement
bgrgicak
reviewed
Apr 16, 2024
Comment on lines
+90
to
+92
| throw new Error( | ||
| `Cannot install asset ${assetFolderName} to ${assetFolderPath} because a file with the same name already exists. Note it's a file, not a directory! Is this by mistake?` | ||
| ); |
There was a problem hiding this comment.
Plugins can be a file, for example, Hello Dolly.
There was a problem hiding this comment.
Actually, that's not a big deal in this case because we always assume a folder name when unzipping a plugin. If the zip contains just a hello-dolly.php file, we'll make up a folder name. It's not perfect, but that's how it works today and changing it is outside of scope of this PR. I'm happy to find a better solution in Blueprints v2.
|
This is great, and overwrite seems like the right default choice. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Adds an
ifAlreadyInstalled?: 'overwrite' | 'skip' | 'error'option to installPlugin and installTheme steps. It defaults tooverwrite.Consider the following Blueprint:
{ "preferredVersions": { "php": "latest", "wp": "6.4" }, "steps": [ { "step": "installTheme", "themeZipFile": { "resource": "wordpress.org/themes", "slug": "twentytwentyfour" } } ] }Before this PR, it would result in an error. After this PR, the installation just works. If the Blueprint author explicitly wants the installation to fail, they can specify the
ifAlreadyInstalledoption:{ "steps": [ { "step": "installTheme", "themeZipFile": { "resource": "wordpress.org/themes", "slug": "twentytwentyfour" }, "ifAlreadyInstalled": "skip" // or "error" } ] }Motivation
Installing a plugin or theme over a currently installed one is a common gotcha. Currently it results in an error and blocks the Blueprint execution. This behavior is, however, often undesirable as it prevents having a single Blueprint that installs a twentytwentyfour theme on different versions of WordPress.
An addition of the
ifAlreadyInstalledoption puts the Blueprint author in control and provides a sensible default behavior where the installation will "just work" by replacing the already installed version of the plugin or theme.Closes #1157
Related to WordPress/blueprints#19
Testing instructions
Confirm the unit tests pass
cc @bgrgicak @brandonpayton