Fix missing index.html validation for admin extension during dev#7304
Closed
MitchLillie wants to merge 1 commit intomainfrom
Closed
Fix missing index.html validation for admin extension during dev#7304MitchLillie wants to merge 1 commit intomainfrom
MitchLillie wants to merge 1 commit intomainfrom
Conversation
When an app with admin.static_root is created and dev is run immediately, the build step may not have completed yet, causing validation to fail on the server side with an unclear error message. This change adds a buildValidation hook to the admin extension specification that checks for the presence of index.html in the static_root directory before starting the dev session. If the file is missing, it throws a clear error message explaining the issue and suggesting to configure a predev hook.
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
1 participant
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.
What
This PR adds a
buildValidationhook to the admin extension specification that checks for the presence ofindex.htmlin thestatic_rootdirectory before starting the dev session.Why
Fixes https://github.com/shop/issues-admin-extensibility/issues/2411
When an app with
admin.static_rootis created and dev is run immediately, the build step may not have completed yet, causing validation to fail on the server side with an unclear error message.How
buildValidationfunction to the admin extension specificationindex.htmlexists in the configuredstatic_rootdirectoryAbortErrorwith guidance to configure a predev hookTesting
buildValidationfunction