-
Notifications
You must be signed in to change notification settings - Fork 868
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: docfx download
command behaviors
#9721
fix: docfx download
command behaviors
#9721
Conversation
f6f8899
to
40ac660
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #9721 +/- ##
==========================================
+ Coverage 74.31% 74.40% +0.08%
==========================================
Files 536 536
Lines 23189 23192 +3
Branches 4056 4027 -29
==========================================
+ Hits 17234 17255 +21
+ Misses 4853 4842 -11
+ Partials 1102 1095 -7 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://github.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/docfx/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/docfx/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/docfx/2.75.3/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/docfx/2.75.3/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://github.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://github.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://github.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://github.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://github.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://github.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://github.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://github.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://github.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://github.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://github.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://github.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://github.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://github.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://github.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://github.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://github.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://github.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://github.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://github.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://github.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://github.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://github.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://github.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://github.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://github.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://github.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://github.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://github.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://github.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://github.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://github.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://github.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) - [@​tbolon](https://github.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - [@​peitschie](https://github.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - [@​voroninp](https://github.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.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:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://github.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/docfx/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/docfx/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/docfx/2.75.3/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/docfx/2.75.3/2.76.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://github.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://github.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://github.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://github.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://github.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://github.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://github.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://github.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://github.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://github.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://github.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://github.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://github.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://github.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://github.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://github.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://github.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://github.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://github.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://github.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://github.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://github.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://github.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://github.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://github.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://github.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://github.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://github.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://github.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://github.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://github.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://github.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://github.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://github.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://github.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://github.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://github.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://github.com/dotnet/docfx/pull/9806) - [@​tbolon](https://github.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://github.com/dotnet/docfx/pull/9810) - [@​peitschie](https://github.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://github.com/dotnet/docfx/pull/9812) - [@​voroninp](https://github.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://github.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.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:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
* fix: docfx download command behaviors * chore: add logics to set baseurl if not exists. and resolve relative href to absolute
This PR intended to fix problems commented at #9659 (comment)
Background
When running
docfx download
with following command.Xrefmap is downloaded as
xrefmap.zip
.However, the contents of
xrefmap.yml
are modified as follows.baseUrl
(https://learn.microsoft.com/dotnet/api/
) is updated tohttps://github.com/dotnet/docfx/raw/main/
.href
with relative URLs are rewritten to absolute URL that based onhttps://github.com/dotnet/docfx/raw/main/
.This PR fix above behaviors by removing relating code.
And this changes.
docfx download
command simply execute following tasks..json
or.yml
file from specified URL.xrefmap.yml
.XRefMap
's references by UID to optimize performance.xrefmap.zip
)What's included in this PR
baseUrl
/href
update related logics that are used whendocfx download
command.CreateMinor
method)XRefMap
type.and to support not properly sorted xrefmap. (sorted:true but not properly sorted) (See: Some Unity uids could not be resolved by xrefmap NormandErwan/UnityXrefMaps#4)
Test
I've tested
docfx download
command with following xrefmaps.And It works as expected.
https://github.com/dotnet/docfx/raw/main/.xrefmap.json
https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml
Additional notes
This PR contains some
docfx download
command behavior changes.It might be better to list changelog as
BREAKIN CHANGES
.