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: filterconfig exclude rule is not works as documented #9666

Merged
merged 4 commits into from
Feb 18, 2024

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Jan 30, 2024

This PR intended to fix #9404

Currently filterconfig.yml's exclude rules are not works as documented.
https://dotnet.github.io/docfx/docs/dotnet-api-docs.html?q=filterconfig#filter-by-uid

When exclude rule is defined without Type attribute.
Namespace symbol type is included as exclusion target.
So types defined at this namespace are not included.

API filter are hierarchical, if a namespace is excluded, all types/members defined in the namespace would also be excluded. Similarly, if a type is excluded, all members defined in the type would also be excluded.

This PR change exclude rule's default kind to ExtendedSymbolKind.Type.

Describe alternatives you've considered
Don't change current behaviors. Fix documentation to explicitly specify type: Type for excude rules.

@filzrev
Copy link
Contributor Author

filzrev commented Jan 30, 2024

Add commit (3fc575b)

  • Change default exclusion type to ExtendedSymbolKind.Type | ExtendedSymbolKind.Member.
  • Change ExtendedSymbolKind to [Flags] enum and assign unique numbers.
    (Because it fails (ExtendedSymbolKind.Type | ExtendedSymbolKind.Member).Contains(new SymbolFilterData { Kind = ExtendedSymbolKind.Interface }) when using current enum value)
  • Add additional unit tests for ExtendedSymbolKind.

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 (1ed7cc3) 74.32%.
Report is 14 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    #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.
📢 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
@filzrev
Copy link
Contributor Author

filzrev commented Feb 12, 2024

I've found issue #8427 that relating to this PR.
Documented sample filter rules are working as expected on older version of docfx.

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.

Thank you @filzrev !

@yufeih yufeih merged commit 679c092 into dotnet:main Feb 18, 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://togithub.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://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 [@&#8203;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 [@&#8203;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
[@&#8203;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 [@&#8203;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 [@&#8203;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
[@&#8203;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 [@&#8203;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
[@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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
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.

API Filtering Yml Cannot Include Specific Namespace
2 participants