Use root package.json values if not in apidoc key #1164
Merged
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
This was the previous behavior in around 0.30 when using apidoc from package.json. I upgraded recently and my docs wound up blank. This is particularly helpful so we don't have to maintain two copies of version in our package.json.
NicolasCARPi
approved these changes
Feb 17, 2022
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.
This was the default behavior around 0.30 or so. I upgraded recently and found the behavior described in issue #1137 . This PR restores the original behavior of pulling
version,name, anddescriptionfrom the root config but does it in a way that will not override anything set directly into theapidockey. This is preferable when using package.json, since then we do not have to maintain two copies of each key (one in root and one inapidoc). This would be particularly annoying with a quickly changingversion.Make sure to read the contributing documentation.
IMPORTANT: Base your PR off the 'dev' branch and target that branch for merging.