Core: Fix error thrown if docs.defaultName is unset#23893
Merged
Conversation
JReinhold
approved these changes
Aug 21, 2023
Contributor
JReinhold
left a comment
There was a problem hiding this comment.
Thanks for this! 💪
defaultName will be set by addon-docs, so this would only fail if a user doesn't have addon-docs installed and sets autodocs: true, which is a weird case.
However it is valid, and we should just ignore it instead of throwing an error.
docs.defaultName is unset
20 tasks
22 tasks
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
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.
Closes #23860
What I did
Fixed a regression that was introduced in #23182 where an invariant was used to enforce
defaultNamebeing defined. WhendefaultNameis undefined, it should default to'Docs'rather than triggering an invariant. See MIGRATION.md here.How to test
Run a sandbox with:
In the
main.tsconfig. Should not get any invariant messages in the logs.Checklist
MIGRATION.MD
Maintainers
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]