feat(core): Add siteConfig.future.experimental_vcs API to read file metadata from Git & other systems
#11512
+696
−22
Conversation
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
…on + config validation tests
✅ [V2]
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Size Change: +324 B (0%) Total Size: 11.8 MB ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +314 B (0%) Total Size: 12.2 MB ℹ️ View Unchanged
|
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.
Motivation
This API introduces flexible config callback hooks to read file metadata from VCS (Version Control Systems) like Git.
Previously, the Docusaurus logic to read from Git was hardcoded. Now, it's possible to override the logic that Docusaurus provides by default.
With these new hooks, you can now read metadata from other systems (Mercurial, SVN, CMS, filesystem, translation SaaS...), and you are not limited to just Git metadata.
This also enables users to optimize these reads, because have found out that the logic we currently use for reading from Git is a bottleneck:
git logcommands to read last update metadata #11208In the future, we'll try to change the historical Git-based implementation we provide, because it doesn't scale well for large sites.
Test Plan
CI + unit tests
Test links
https://deploy-preview-11512--docusaurus-2.netlify.app/