Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/docs/v4/welcome/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,15 @@ The following sections provide details on the changes per Steeltoe component, as

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Bootstrap.Autoconfig.SteeltoeAssemblies` | Type | Steeltoe.Bootstrap.Autoconfig | Renamed | `Steeltoe.Bootstrap.AutoConfiguration.SteeltoeAssemblyNames` | Updated members to new/changed assembly names |
| `Steeltoe.Connector` | Namespace | Steeltoe.Bootstrap.Autoconfig | Removed | None | Type locators have been replaced with internal-only shims |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1434
Expand Down Expand Up @@ -201,6 +205,8 @@ For more information, see the updated [Bootstrap documentation](../bootstrap/ind

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Microsoft.Extensions.DependencyInjection.ConfigurationServiceInstanceProviderServiceCollectionExtensions.AddConfigurationDiscoveryClient` | Extension method | Steeltoe.Common [Abstractions] | Moved | Steeltoe.Discovery.Configuration package | |
Expand Down Expand Up @@ -292,6 +298,8 @@ For more information, see the updated [Bootstrap documentation](../bootstrap/ind
| `Steeltoe.Common.Security.PemCertificateSource` | Type | Steeltoe.Common.Security | Removed | Store certificate paths in `IConfiguration` | Refactored to use ASP.NET Options pattern |
| `Steeltoe.Common.Security.PemConfigureCertificateOptions` | Type | Steeltoe.Common.Security | Removed | Store certificate paths in `IConfiguration` | Refactored to use ASP.NET Options pattern |

</div>

[^1]: When using the binary buildpack, specify port bindings in an [environment variable](https://learn.microsoft.com/aspnet/core/fundamentals/servers/kestrel/endpoints#specify-ports-only) or on the command-line: `--urls=http://0.0.0.0:%PORT%`.

### Notable PRs
Expand Down Expand Up @@ -346,6 +354,8 @@ For more information, see the updated [Bootstrap documentation](../bootstrap/ind

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Configuration.ICompositeConfigurationSource` | Type | Steeltoe.Configuration.Abstractions | Added | | Building block for configuration providers |
Expand Down Expand Up @@ -431,6 +441,8 @@ For more information, see the updated [Bootstrap documentation](../bootstrap/ind
| `Steeltoe.Extensions.Configuration.SpringBoot.SpringBootEnvSource` | Type | Steeltoe.Extensions.Configuration.SpringBoot [Base/Core] | Removed | None | Renamed to internal `SpringBootEnvironmentVariableSource` |
| `Steeltoe.Extensions.Configuration.SpringBoot.SpringBootHostBuilderExtensions.AddSpringBootConfiguration` | Extension method | Steeltoe.Extensions.Configuration.SpringBoot [Base/Core] | Removed | `builder.Configuration.AddSpringBootFromCommandLine/EnvironmentVariable()` | Redundant |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1360
Expand Down Expand Up @@ -490,6 +502,8 @@ For more information, see the updated [Configuration documentation](../configura

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Connector.AbstractServiceConnectorOptions` | Type | Steeltoe.Connector.Connector [Base/Core] | Removed | None | Redundant after refactorings |
Expand Down Expand Up @@ -602,6 +616,8 @@ For more information, see the updated [Configuration documentation](../configura
| `Steeltoe.Connector.SqlServer.EFCore.SqlServerDbContextOptionsExtensions.UseSqlServer` | Extension method | Steeltoe.Connector.EFCore | Moved | `SqlServerDbContextOptionsBuilderExtensions.UseSqlServer` | Takes an `IServiceProvider`, requires call to `builder.AddSqlServer()` first |
| `Steeltoe.Connector.SqlServer.EFCore.SqlServerDbContextOptionsExtensions.UseSqlServer<TContext>` | Extension method | Steeltoe.Connector.EFCore | Removed | | Redundant |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1528
Expand Down Expand Up @@ -663,6 +679,8 @@ For more information, see the updated [Connectors documentation](../configuratio

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Discovery.Client.ConfigurationUrlHelpers` | Type | Steeltoe.Discovery.Client [Base/Core] | Removed | None | Similar logic moved to internal `ConfigurationExtensions.GetListenAddresses` |
Expand Down Expand Up @@ -871,6 +889,8 @@ For more information, see the updated [Connectors documentation](../configuratio
| `Steeltoe.Discovery.Eureka.Transport.IEurekaHttpClient` | Type | Steeltoe.Discovery.Eureka | Removed | `Steeltoe.Discovery.Eureka.EurekaClient` | |
| `Steeltoe.Discovery.Eureka.Util.DateTimeConversions` | Type | Steeltoe.Discovery.Eureka | Removed | None | Made internal |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1372
Expand Down Expand Up @@ -918,6 +938,8 @@ For more information, see the updated [Discovery documentation](../discovery/ind

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Extensions.Logging.DynamicLoggerConfiguration` | Type | Steeltoe.Extensions.Logging.Abstractions | Renamed | `Steeltoe.Logging.DynamicLoggerState` | Represents logger state, is unrelated to `IConfiguration` |
Expand Down Expand Up @@ -960,6 +982,8 @@ For more information, see the updated [Discovery documentation](../discovery/ind
| `Steeltoe.Extensions.Logging.DynamicSerilog.SerilogWebHostBuilderExtensions.UseSerilogDynamicConsole` | Extension method | Steeltoe.Extensions.Logging.DynamicSerilog [Base/Core] | Removed | `ILoggingBuilder.AddDynamicSerilog()` | |
| `Steeltoe.Logging.DynamicSerilog.SerilogMessageProcessingLogger` | Type | Steeltoe.Logging.DynamicSerilog | Added | | Preserve structured logs with `IDynamicMessageProcessor` in Serilog |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1468
Expand Down Expand Up @@ -1018,6 +1042,8 @@ For more information, see the updated [Logging documentation](../logging/index.m

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Microsoft.Diagnostics.Runtime.Interop.IMAGE_FILE_MACHINE` | Type | Steeltoe.Management.Diagnostics | Removed | None | |
Expand Down Expand Up @@ -1356,6 +1382,8 @@ For more information, see the updated [Logging documentation](../logging/index.m
| `Steeltoe.Management.Tracing.TracingOptions` | Type | Steeltoe.Management.Tracing [Base/Core] | Removed | Use OpenTelemetry packages directly | |
| `Steeltoe.Management.Tracing.TracingServiceCollectionExtensions.AddTracingLogProcessor` | Extension method | Steeltoe.Management.Tracing | Added | | Add trace info from `Activity.Current` to logs |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1521
Expand Down Expand Up @@ -1440,6 +1468,8 @@ For more information, see the updated [Management documentation](../management/i

### API changes

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Security.Authentication.CloudFoundry.ApplicationBuilderExtensions.UseCloudFoundryCertificateAuth` | Extension method | Steeltoe.Security.Authentication.CloudFoundry [Base/Core] | Removed | `app.UseCertificateAuthorization()` | |
Expand Down Expand Up @@ -1494,12 +1524,16 @@ For more information, see the updated [Management documentation](../management/i
| `Steeltoe.Security.DataProtection.Redis.RedisDataProtectionBuilderExtensions.PersistKeysToRedis` | Extension method | Steeltoe.Security.DataProtection.Redis | Added | | Takes an optional service binding name |
| `Steeltoe.Security.DataProtection.RedisDataProtectionBuilderExtensions.PersistKeysToRedis` | Extension method | Steeltoe.Security.DataProtection.RedisCore | Moved | `PersistKeysToRedis()` in Steeltoe.Security.DataProtection.Redis package | |

</div>

### Breaking API changes after the 4.0 release

The table above reflects the API surface as of the initial Steeltoe 4.0 release. The following breaking changes were introduced in later 4.x releases.

#### Steeltoe.Security changes in 4.3

<div class="text-nowrap">

| Source | Kind | Package | Change | Replacement | Notes |
| --- | --- | --- | --- | --- | --- |
| `Steeltoe.Security.Authorization.Certificate.CertificateAuthorizationBuilderExtensions.AddOrgAndSpacePolicies` | Extension method | Steeltoe.Security.Authorization.Certificate | Obsolete | `AddOrgAndSpacePoliciesForMutualTls()` | Header-based certificate forwarding can be spoofed by any client |
Expand All @@ -1509,6 +1543,8 @@ The table above reflects the API surface as of the initial Steeltoe 4.0 release.
| `Steeltoe.Security.Authorization.Certificate.CertificateHttpClientBuilderExtensions.AddClientCertificate` | Extension method | Steeltoe.Security.Authorization.Certificate | Obsolete | `AddClientCertificateForMutualTls(string)` | Header-based certificate injection can be spoofed by any client |
| `Steeltoe.Security.Authorization.Certificate.CertificateHttpClientBuilderExtensions.AddClientCertificateForMutualTls` | Extension method | Steeltoe.Security.Authorization.Certificate | Added | | Send custom certificate with outgoing HTTP requests using mTLS |

</div>

### Notable PRs

- https://github.com/SteeltoeOSS/Steeltoe/pull/1525
Expand Down
Loading