search

Xabaril / AspNetCore.Diagnostics.HealthChecks

Enterprise HealthChecks for ASP.NET Core Diagnostics Package
Apache License 2.0
3.98k stars 771 forks source link

Fix naming in openid connect server healthcheck #2198

Open jakubriha opened 2 months ago

jakubriha commented 2 months ago

What this PR does / why we need it: The PR is fixing the naming in the OpenID Connect server health check to use the OpenID Connect/OIDC instead of IdentityServer. The project name and folder was already renamed in the past but the rest of the project wasn't. This PR fixes that.

Moreover, it fixes few things, like invalid paths in healthchecks_openidconnectserver_ci.yml and adds README.

Which issue(s) this PR fixes: close #343

Special notes for your reviewer: None.

Does this PR introduce a user-facing change?: Yes, it renames the original registration extension method:

services
    .AddHealthChecks()
-   .AddIdentityServer(oidcSvrUri: new Uri("https://myoidcserver.com"));
+   .AddOpenIdConnectServer(oidcSvrUri: new Uri("https://myoidcserver.com"));

This breaking change will fail user's builds. Let me know and I can optionally keep the old AddIdentityServer method and mark it as obsolete if preferred.

The PR renames the health check class and builder extension class.

The PR also renames the default tag name from idsvr to oidcserver.

jakubriha commented 2 months ago

@dotnet-policy-service agree