feat: Add support for gzipped xrefmap that stored as local file #9966
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
filzrev
force-pushed
the
feat-add-gzipped-xrefmap-support
branch
from
004ad3b to
a097c35
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9966 +/- ##
==========================================
+ Coverage 74.31% 78.91% +4.59%
==========================================
Files 536 540 +4
Lines 23189 23439 +250
Branches 4056 4060 +4
==========================================
+ Hits 17234 18497 +1263
+ Misses 4853 3804 -1049
- Partials 1102 1138 +36 ☔ View full report in Codecov by Sentry. |
|
will a |
yufeih
added
the
performance
filzrev
changed the title
This PR intended to support gzipped files that saved on local files. For In this case. Alternatively. It can use xrefmap provided by |
yufeih
added
new-feature
p-kostov
pushed a commit
to ErpNetDocs/docfx
that referenced
this pull request
Jun 28, 2024
…et#9966) feat: add gzipped xrefmap file support
renovate bot
referenced
this pull request
in buehler/dotnet-operator-sdk
Jul 1, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://togithub.com/dotnet/docfx) | `2.76.0` -> `2.77.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.77.0`](https://togithub.com/dotnet/docfx/releases/tag/v2.77.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 💥 Breaking Changes - chore: Drop .NET 7 SDK supports by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9911](https://togithub.com/dotnet/docfx/pull/9911) ##### 🎉 New Features - feat: Enable PreferCSSPageSize option for PDF generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9850](https://togithub.com/dotnet/docfx/pull/9850) - feat: Add docfx JSON Schema files and related tests by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9852](https://togithub.com/dotnet/docfx/pull/9852) - feat: Add `toc.json` transform logics using `toc.extension.js` by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9953](https://togithub.com/dotnet/docfx/pull/9953) - feat: Better error when link not found by [@​Patrick8639](https://togithub.com/Patrick8639) in [https://github.com/dotnet/docfx/pull/9957](https://togithub.com/dotnet/docfx/pull/9957) - feat: Add `categoryLayout` option for metadata generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9965](https://togithub.com/dotnet/docfx/pull/9965) - feat: Permits to specify the placement of overwrites by [@​Patrick8639](https://togithub.com/Patrick8639) in [https://github.com/dotnet/docfx/pull/9937](https://togithub.com/dotnet/docfx/pull/9937) - feat: Support private symbols by [@​Patrick8639](https://togithub.com/Patrick8639) in [https://github.com/dotnet/docfx/pull/9972](https://togithub.com/dotnet/docfx/pull/9972) - feat: Add support for gzipped xrefmap that stored as local file by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9966](https://togithub.com/dotnet/docfx/pull/9966) - feat: Enable view transitions feature by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9909](https://togithub.com/dotnet/docfx/pull/9909) ##### 🐞 Bug Fixes - fix: PDF `Producer` document information by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9851](https://togithub.com/dotnet/docfx/pull/9851) - fix: Xrefmap baseUrl problem reported at [#​9866](https://togithub.com/dotnet/docfx/issues/9866) by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9869](https://togithub.com/dotnet/docfx/pull/9869) - fix: Xref links are not resolved on docs site by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9880](https://togithub.com/dotnet/docfx/pull/9880) - fix: Change same URL check logic to case invariant by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9883](https://togithub.com/dotnet/docfx/pull/9883) - fix: Improve unresolved xref messages by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9884](https://togithub.com/dotnet/docfx/pull/9884) - fix: Fix nightly build errors by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9913](https://togithub.com/dotnet/docfx/pull/9913) - fix: TOC filter value is not shared between pages by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9912](https://togithub.com/dotnet/docfx/pull/9912) - fix: Build problems when running .NET 6 version of docfx on some environment by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9922](https://togithub.com/dotnet/docfx/pull/9922) - fix: `docfx metadata` command throw `ArgumentException` when referencing empty namespace by doc comment by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/10023](https://togithub.com/dotnet/docfx/pull/10023) - fix: serve url link by [@​WeihanLi](https://togithub.com/WeihanLi) in [https://github.com/dotnet/docfx/pull/10035](https://togithub.com/dotnet/docfx/pull/10035) ##### 🚀 Performance Improvements - perf: Change serializer for XrefMap from NewtonsoftJson to System.Text.Json by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9872](https://togithub.com/dotnet/docfx/pull/9872) - perf: Remove some enum boxing in GlobMatcher by [@​lahma](https://togithub.com/lahma) in [https://github.com/dotnet/docfx/pull/10051](https://togithub.com/dotnet/docfx/pull/10051) - perf: Optimize CountWordInText by [@​lahma](https://togithub.com/lahma) in [https://github.com/dotnet/docfx/pull/10050](https://togithub.com/dotnet/docfx/pull/10050) ##### 🔧 Engineering - chore: Skip unstable SVG content check that returned from PlantUML Online Server by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9858](https://togithub.com/dotnet/docfx/pull/9858) - deps: Update Spectre.Console package versions by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9894](https://togithub.com/dotnet/docfx/pull/9894) - chore: fix NU5129 warning on `dotnet pack` command by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9942](https://togithub.com/dotnet/docfx/pull/9942) - chore: Add PolySharp libarary to use latest C# syntax by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9960](https://togithub.com/dotnet/docfx/pull/9960) - chore: Add snapshot update workflow by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9969](https://togithub.com/dotnet/docfx/pull/9969) - chore: Remove unused workflow settings by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/10030](https://togithub.com/dotnet/docfx/pull/10030) ##### 📄 Documentation - docs: Fix typo by [@​carlos-regis](https://togithub.com/carlos-regis) in [https://github.com/dotnet/docfx/pull/9871](https://togithub.com/dotnet/docfx/pull/9871) - docs: Fix URL in markdown and match to html example by [@​si618](https://togithub.com/si618) in [https://github.com/dotnet/docfx/pull/9881](https://togithub.com/dotnet/docfx/pull/9881) - docs: Fix documentation site build warnings by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9895](https://togithub.com/dotnet/docfx/pull/9895) - docs: Fix missing docfx.json config docs by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9935](https://togithub.com/dotnet/docfx/pull/9935) - docs: Fix Docfx.App nuget package usage document by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9994](https://togithub.com/dotnet/docfx/pull/9994) - docs: Fix plugin related docs and logs by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/10029](https://togithub.com/dotnet/docfx/pull/10029) #### New Contributors - [@​carlos-regis](https://togithub.com/carlos-regis) made their first contribution in [https://github.com/dotnet/docfx/pull/9871](https://togithub.com/dotnet/docfx/pull/9871) - [@​si618](https://togithub.com/si618) made their first contribution in [https://github.com/dotnet/docfx/pull/9881](https://togithub.com/dotnet/docfx/pull/9881) - [@​Patrick8639](https://togithub.com/Patrick8639) made their first contribution in [https://github.com/dotnet/docfx/pull/9957](https://togithub.com/dotnet/docfx/pull/9957) **Full Changelog**: dotnet/docfx@v2.76.0...v2.77.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/buehler/dotnet-operator-sdk). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
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 PR add support for
gzip compressedxrefmap file.Background
xrefmapfiles can exceed 100 MB in size in some cases.For example. .NET API's xrefmap takes
132MB. (And8.5MB when using gzip compression)And when specifying xrefmap with URL schema.
docfx download xrefmap file on every build.
So it's recommended to use pre downloaded local file for large xrefmap.
But in this case, xrefmap can't be stored on GitHub repository. (By default it's limited to50MB and It requires git LFS for larger file)
And currently there is zipped xrefmap support that compressed by
zip.But it support only
ymlformat that is created bydotnet downloadcommand.And yml file processing run 4x slower than json.
This PR add support for gzipped xrefmap file to resolve described above issue.