fix: filterconfig exclude rule is not works as documented#9666
Merged
yufeih merged 4 commits intodotnet:mainfrom Feb 18, 2024
Merged
fix: filterconfig exclude rule is not works as documented#9666yufeih merged 4 commits intodotnet:mainfrom
yufeih merged 4 commits intodotnet:mainfrom
Conversation
Collaborator
Author
|
Add commit (3fc575b)
|
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #9666 +/- ##
=======================================
Coverage 74.31% 74.32%
=======================================
Files 536 536
Lines 23189 23191 +2
Branches 4056 4058 +2
=======================================
+ Hits 17234 17237 +3
+ Misses 4853 4852 -1
Partials 1102 1102 ☔ View full report in Codecov by Sentry. |
Collaborator
Author
|
I've found issue #8427 that relating to this PR. |
yufeih
approved these changes
Feb 18, 2024
renovate bot
referenced
this pull request
in dotnet/dotnet-operator-sdk
Feb 18, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://togithub.com/dotnet/docfx) | `2.75.2` -> `2.75.3` | [](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.75.3`](https://togithub.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 [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9665](https://togithub.com/dotnet/docfx/pull/9665) - fix: Warnings that occurs when bookmark link contains non-ASCII chars by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9660](https://togithub.com/dotnet/docfx/pull/9660) - fix: Add StackTrace logs for Javascript error by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9694](https://togithub.com/dotnet/docfx/pull/9694) - fix: InvalidInputFile error occurs if file contains URI escaped charactors by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9700](https://togithub.com/dotnet/docfx/pull/9700) - fix: Add fail-fast logics when `--serve` option enabled & port is already used by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9690](https://togithub.com/dotnet/docfx/pull/9690) - fix: filterconfig exclude rule is not works as documented by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9666](https://togithub.com/dotnet/docfx/pull/9666) ##### 🔧 Engineering - build(deps): bump YamlDotNet from 15.1.0 to 15.1.1 dependencies .NET by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9689](https://togithub.com/dotnet/docfx/pull/9689) - chore: update NuGet package dependencies (Microsoft.NET.Test.Sdk,Microsoft.Build.Locator) by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9693](https://togithub.com/dotnet/docfx/pull/9693) - chore: Update public API snapshot & disable `AutoVerify` on CI build by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9692](https://togithub.com/dotnet/docfx/pull/9692) - chore: Update node.js version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9701](https://togithub.com/dotnet/docfx/pull/9701) - chore: Update Microsoft.Build package version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9698](https://togithub.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>
p-kostov
pushed a commit
to ErpNetDocs/docfx
that referenced
this pull request
Jun 28, 2024
* fix: filterconfig exclude rule is not works as documented * fix: change ExtendedSymbolKind to flags enum
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
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 intended to fix #9404
Currently
filterconfig.yml'sexcluderules are not works as documented.https://dotnet.github.io/docfx/docs/dotnet-api-docs.html?q=filterconfig#filter-by-uid
When
excluderule is defined withoutTypeattribute.Namespacesymbol type is included as exclusion target.So types defined at this namespace are not included.
This PR change
excluderule's default kind toExtendedSymbolKind.Type.Describe alternatives you've considered
Don't change current behaviors. Fix documentation to explicitly specify
type: Typefor excude rules.