Skip to content
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: Toc warnings when toc item with TopicUid but name is not specified #9665

Merged
merged 2 commits into from
Feb 10, 2024

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Jan 30, 2024

This PR intended to fix #9664 #9649.
By adding lines to skip warnings when TopicUid value exists.

Because if TocItem contains a TopicUid value.
It seems node.Name is automatically resolved by TocDocumentProcessor.

private static void ResolveUid(TocItemViewModel item, FileModel model, IDocumentBuildContext context, string includedFrom)
{
if (item.TopicUid != null)
{
var xref = GetXrefFromUid(item.TopicUid, model, context, includedFrom);
if (xref != null)
{
item.Href = item.TopicHref = xref.Href;
if (string.IsNullOrEmpty(item.Name))
{
item.Name = xref.Name;
}
}
}

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (fe673ec) 74.31% compared to head (0648e4b) 74.31%.
Report is 8 commits behind head on main.

Files Patch % Lines
src/Docfx.Build/ManifestProcessor.cs 0.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9665      +/-   ##
==========================================
- Coverage   74.31%   74.31%   -0.01%     
==========================================
  Files         536      536              
  Lines       23189    23190       +1     
  Branches     4056     4057       +1     
==========================================
  Hits        17234    17234              
  Misses       4853     4853              
- Partials     1102     1103       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yufeih yufeih added the bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note label Feb 10, 2024
Copy link
Contributor

@yufeih yufeih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you @filzrev !

@yufeih yufeih merged commit 02173a7 into dotnet:main Feb 10, 2024
8 checks passed
renovate bot referenced this pull request in buehler/dotnet-operator-sdk Feb 18, 2024
[![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.2` -> `2.75.3` |
[![age](https://developer.mend.io/api/mc/badges/age/nuget/docfx/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/docfx/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/docfx/2.75.2/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/docfx/2.75.2/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>dotnet/docfx (docfx)</summary>

### [`v2.75.3`](https://github.com/dotnet/docfx/releases/tag/v2.75.3)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### 🐞 Bug Fixes

- fix: Toc warnings when toc item with TopicUid but name is not
specified by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9665](https://github.com/dotnet/docfx/pull/9665)
- fix: Warnings that occurs when bookmark link contains non-ASCII chars
by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9660](https://github.com/dotnet/docfx/pull/9660)
- fix: Add StackTrace logs for Javascript error by
[@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9694](https://github.com/dotnet/docfx/pull/9694)
- fix: InvalidInputFile error occurs if file contains URI escaped
charactors by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9700](https://github.com/dotnet/docfx/pull/9700)
- fix: Add fail-fast logics when `--serve` option enabled & port is
already used by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9690](https://github.com/dotnet/docfx/pull/9690)
- fix: filterconfig exclude rule is not works as documented by
[@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9666](https://github.com/dotnet/docfx/pull/9666)

##### 🔧 Engineering

- build(deps): bump YamlDotNet from 15.1.0 to 15.1.1 dependencies .NET
by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9689](https://github.com/dotnet/docfx/pull/9689)
- chore: update NuGet package dependencies
(Microsoft.NET.Test.Sdk,Microsoft.Build.Locator) by
[@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9693](https://github.com/dotnet/docfx/pull/9693)
- chore: Update public API snapshot & disable `AutoVerify` on CI build
by [@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9692](https://github.com/dotnet/docfx/pull/9692)
- chore: Update node.js version by
[@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9701](https://github.com/dotnet/docfx/pull/9701)
- chore: Update Microsoft.Build package version by
[@&#8203;filzrev](https://github.com/filzrev) in
[https://github.com/dotnet/docfx/pull/9698](https://github.com/dotnet/docfx/pull/9698)

**Full Changelog**:
dotnet/docfx@v2.75.2...v2.75.3

</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:eyJjcmVhdGVkSW5WZXIiOiIzNy4xOTEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjE5MS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@filzrev filzrev deleted the fix-toc-warnings-for-topicuid branch April 1, 2024 05:03
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
…ed (dotnet#9665)

fix: warnings for tocitem when topicuid  specified but name is not specified
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants