Skip to content

main CI is red since #178: the README API test rejects the #166 binary-compatibility overloads, so none of the fixes in #166–#182 can release #183

Open

Description

@matt-edmondson

What's wrong

EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults (TextFilter.Test/ReadmeTests.cs:108) fails on every OS. The push run for 5f420d9 (#182) on main, run 41750874530, failed on it on macOS and Windows. The runs for the commits before it were cancelled.

dotnet test at HEAD gives 267 passed, 1 failed:

IsMatch(filterType) is documented as defaulting to TextFilterType.Glob; IsMatch(textFilterMatchOptions) ... ByWordAny; Filter(filterType) ...; Filter(textFilterMatchOptions) ...

Cause

#166 added TextFilter.BinaryCompatibility.cs. It restores the pre-1.7 IsMatch/Filter/DoesMatchGlob signatures, and their parameters deliberately have no defaults, because two sets of overloads with defaults would be ambiguous.

The README test added in #178 requires every overload's same-named parameter to carry the README's default:

else if (parameters.Any(p => !p.HasDefaultValue || $"{p.ParameterType.Name}.{p.DefaultValue}" != expected))

The compatibility overloads fail that by design.

Why it matters

A red main blocks the release pipeline. NuGet's latest is still 1.7.14-pre.3, so none of the fixes from #166 to #182 have shipped. That includes the MissingMethodException fix for #155, which is the point of #166. The open PRs also show failed CI for the same reason.

Suggested fix

Change the check so the compatibility overloads pass. Either of these works:

  • Skip methods marked [EditorBrowsable(EditorBrowsableState.Never)], or those declared in the compatibility file.
  • Require at least one overload to carry the documented default, and fail only when an overload has a different default: p.HasDefaultValue && value != expected.

Acceptance: dotnet test is green at HEAD and the CI push run on main passes.

Activity

  1. added 3 commits that reference this issue on Nov 4, 2026
    6f196b4
    0f17af1
    5ffdca0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

bugSomething isn't working

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions