From 9f97cd181da58a88156e11bb2d111c035486f993 Mon Sep 17 00:00:00 2001 From: Andrew White Date: Sat, 21 Dec 2024 18:16:12 -0500 Subject: [PATCH] chore: doc and readme updates --- CHANGELOG.md | 36 ++++++++++++------------ README.md | 66 ++++++++++++++++++++++++++++---------------- docs/History.md | 3 +- docs/Introduction.md | 20 ++++++++++++-- docs/WhatsNew.md | 3 +- 5 files changed, 79 insertions(+), 49 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dad2c2af..3c117828 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,12 @@ -# [9.0.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v8.0.0...v9.0.0) (2024-11-13) +## [9.0.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v8.0.0...v9.0.0) (2024-11-13) + + +### ⚠ BREAKING CHANGES + +* `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. +* `MultiTenantDbContext` constructors accepting `ITenantInfo` removed, use `MultiTenantDbContext.Create` factory method instead. +* net6.0 and net7.0 are no longer supported targets. +* dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs. ### Features @@ -8,23 +16,12 @@ * dotnet 9 support ([#893](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/893)) ([4be1b88](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/4be1b88fb7103223517d2cd8a16ea62c6d6204d5)) * make builds deterministic and set latest GH actions ([#889](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/889)) ([d82f89d](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/d82f89da2f7a82bb302aaedfdb5c676cc7051273)) +## [8.0.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v7.0.2...v8.0.0) (2024-10-12) -### BREAKING CHANGES - -* `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. -* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory method -* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext .Create` factory method instead -* net6.0 and net7.0 are no longer supported targets. -* dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs. - -# [8.0.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v7.0.2...v8.0.0) (2024-10-12) - -### Bug Fixes - -* BasePathStrategy no longer breaks the strategy chain ([#884](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/884)) ([3263eff](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/3263effae4638656aab827b24094a8e575ae19a0)) -* prevent duplicate key annotation in AdjustKey() ([#883](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/883)) ([f75ba2c](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/f75ba2c678079d2e956bf7d32b8e5aee0159e72b)) -* removed unused parameter from WithPerTenantRemoteAuthenticationConvention ([#886](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/886)) ([dd17ab5](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/dd17ab51825ec94f4ecfe704f42c6b0457562d98)) +### ⚠ BREAKING CHANGES +* This commit brings the release into alignment with the new version policy. See #887 for details. +* Included strategies for ASP.NET Core would throw an exception if the passed context was not an `HttpContext` type. Now they will return null indicating no identifier was found. ### Features @@ -32,11 +29,12 @@ * added the Echo Store. ([#807](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/807)) ([a3e5eee](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/a3e5eee64f0581c5f3d6abca7bb77cc56ef1d75c)) * strategies return null on invalid context type ([#885](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/885)) ([9834575](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/9834575c957fb5bd314cf0970e54a29384026d02)) +### Bug Fixes -### BREAKING CHANGES +* BasePathStrategy no longer breaks the strategy chain ([#884](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/884)) ([3263eff](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/3263effae4638656aab827b24094a8e575ae19a0)) +* prevent duplicate key annotation in AdjustKey() ([#883](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/883)) ([f75ba2c](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/f75ba2c678079d2e956bf7d32b8e5aee0159e72b)) +* removed unused parameter from WithPerTenantRemoteAuthenticationConvention ([#886](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/886)) ([dd17ab5](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/dd17ab51825ec94f4ecfe704f42c6b0457562d98)) -* This commit brings the release into alignment with the new version policy. See #887 for details. -* Included strategies for ASP.NET Core would throw an exception if the passed context was not an `HttpContext` type. Now they will return null indicating no identifier was found. ## [7.0.2](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v7.0.1...v7.0.2) (2024-08-03) diff --git a/README.md b/README.md index 61f86cb8..0d209443 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,40 @@ Finbuckle.MultiTenant is an open-source multitenancy middleware library for .NET per-tenant app behavior, and per-tenant data isolation. See [https://www.finbuckle.com/multitenant](https://www.finbuckle.com/multitenant) for more details and documentation. -**This release supports .NET 8 and .NET 9.** +**This release supports .NET 9 and .NET 8.** -Current publish feed release: -![Finbuckle.MultiTenant NuGet.org badge](https://buildstats.info/nuget/finbuckle.multitenant) +## Open Source Support Table of Contents 1. [What's New in v9.0.0](#whats-new) -2. [Quick Start](#quick-start) -3. [Documentation](#documentation) -4. [Sample Projects](#sample-projects) -5. [Build and Test Status](#build-and-test-status) -6. [License](#license) -7. [.NET Foundation](#net-foundation) -8. [Code of Conduct](#code-of-conduct) -9. [Community](#community) -10. [Building from Source](#building-from-source) -11. [Running Unit Tests](#running-unit-tests) +2. [Open Source Support](#open-source-support) +3. [Quick Start](#quick-start) +4. [Documentation](#documentation) +5. [Sample Projects](#sample-projects) +6. [Build and Test Status](#build-and-test-status) +7. [License](#license) +8. [.NET Foundation](#net-foundation) +9. [Code of Conduct](#code-of-conduct) +10. [Community](#community) +11. [Building from Source](#building-from-source) +12. [Running Unit Tests](#running-unit-tests) ## What's New in v9.0.0 > This section only lists release update details specific to v9.0.0. See > the [changelog file](CHANGELOG.md) for all release update details. + # [9.0.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/compare/v8.0.0...v9.0.0) (2024-11-13) +### ⚠ BREAKING CHANGES + +* `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. +* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory method instead. +* net6.0 and net7.0 are no longer supported targets. +* dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs. + ### Features * add multitenant db factory method ([#894](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/894)) ( @@ -39,16 +47,27 @@ Table of Contents * better tenant resolution events ([#897](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/897)) ([956ca36](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/956ca36670aa8aed38afcbbbdd78f1b79d91287c)) * dotnet 9 support ([#893](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/893)) ([4be1b88](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/4be1b88fb7103223517d2cd8a16ea62c6d6204d5)) * make builds deterministic and set latest GH actions ([#889](https://github.com/Finbuckle/Finbuckle.MultiTenant/issues/889)) ([d82f89d](https://github.com/Finbuckle/Finbuckle.MultiTenant/commit/d82f89da2f7a82bb302aaedfdb5c676cc7051273)) + +## Open Source Support -### BREAKING CHANGES +Your support helps keep the project going and is greatly appreciated! -* `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. -* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory - method* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory method instead. -* net6.0 and net7.0 are no longer supported targets. -* dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs. - +Finbuckle.MultiTenant is primarily supported by its [GitHub sponsors](https://github.com/sponsors/Finbuckle) and [contributors](https://github.com/Finbuckle/Finbuckle.MultiTenant/graphs/contributors). + +Additional support is provided by the following organizations: + +

+ Digital Ocean logo +

+ +

+ GitHub logo +

+ +

+ Jetbrains logo +

## Quick Start @@ -119,8 +138,8 @@ ways. `app.UseMultiTenant()` This line configures the middleware which resolves the tenant using the registered strategies, stores, and other -settings. Be sure to call it before other middleware which will use per-tenant functionality, -e.g. `UseAuthentication()`. +settings. Be sure to call it before other middleware which will use per-tenant functionality, e.g. +`UseAuthentication()`. ### Basic Usage @@ -148,8 +167,7 @@ See [Configuration and Usage](https://www.finbuckle.com/MultiTenant/Docs/Configu ## Documentation The library builds on this basic functionality to provide a variety of higher level features. See -the [documentation](https://www.finbuckle.com/multitenant/docs) for -more details: +the [documentation](https://www.finbuckle.com/multitenant/docs) for more details: * [Per-tenant Options](https://www.finbuckle.com/MultiTenant/Docs/Options) * [Per-tenant Authentication](https://www.finbuckle.com/MultiTenant/Docs/Authentication) diff --git a/docs/History.md b/docs/History.md index 5d6d7321..50e9a264 100644 --- a/docs/History.md +++ b/docs/History.md @@ -6,8 +6,7 @@ ### ⚠ BREAKING CHANGES * `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. -* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory - method* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory method instead. +* `MultiTenantDbContext` constructors accepting `ITenantInfo` removed, use `MultiTenantDbContext.Create` factory method instead. * net6.0 and net7.0 are no longer supported targets. * dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs. diff --git a/docs/Introduction.md b/docs/Introduction.md index 0ca368d5..e89cd095 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -16,9 +16,25 @@ fixes will be released for prior versions which target .NET versions supported b In general, you should target the version of Finbuckle.MultiTenant that matches your .NET version. -## Main Build and Test Status +## Open Source Support -![Build and Test Status](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/ci.yml/badge.svg) +Your support helps keep the project going and is greatly appreciated! + +Finbuckle.MultiTenant is primarily supported by its [GitHub sponsors](https://github.com/sponsors/Finbuckle) and [contributors](https://github.com/Finbuckle/Finbuckle.MultiTenant/graphs/contributors). + +Additional support is provided by the following organizations: + +

+ Digital Ocean logo +

+ +

+ GitHub logo +

+ +

+ Jetbrains logo +

## License diff --git a/docs/WhatsNew.md b/docs/WhatsNew.md index c40f4e0f..67427612 100644 --- a/docs/WhatsNew.md +++ b/docs/WhatsNew.md @@ -8,8 +8,7 @@ ### ⚠ BREAKING CHANGES * `OnTenantResolved` and `OnTenantNotResolved` are no longer used. Use the `OnStrategyResolveCompleted`, `OnStoreResolveCompleted`, and `OnTenantResolveCompleted` events instead. -* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory - method* `MultiTenantDbContext` constructors accepting ITenantInfo removed, use `MultiTenantDbContext.Create` factory method instead. +* `MultiTenantDbContext` constructors accepting `ITenantInfo` removed, use `MultiTenantDbContext.Create` factory method instead. * net6.0 and net7.0 are no longer supported targets. * dotnet runtime specific dependencies now float to the latest patch version and are locked at release time with a NuGet lock file. This is a security mitigation and may break some builds not on the latest SDKs.