diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 9872c7932..6eeff9eb3 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,7 +1,9 @@
name: Release
on:
push:
- branches: [ "release/24.0" ] # main
+ branches:
+ - main
+ #- 'release/24.0'
env:
WORKFLOW_VAR: Release # ${{ vars.WORKFLOW_VAR }}
jobs:
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index e495fe279..18aa68cef 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
- python: "3.11"
+ python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
diff --git a/LICENSE.md b/LICENSE.md
index e4ad3be15..3a0b5c459 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,8 +1,19 @@
The MIT License (MIT)
Copyright © 2016-2025 Tom Gardham-Pallister, Raman Maksimchuk and contributors.
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and / or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMP-
+LIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNEC-
+TION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index b80594463..f4163fe09 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
-[](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml)
-[](https://app.readthedocs.org/projects/ocelot/builds/?version__slug=develop)
-[](https://coveralls.io/github/ThreeMammals/Ocelot?branch=develop)
-[](https://github.com/ThreeMammals/Ocelot/blob/develop/LICENSE.md)
-[](https://www.nuget.org/packages/Ocelot/)
-[](https://www.nuget.org/packages/Ocelot/)
+[](https://github.com/ThreeMammals/Ocelot/actions/workflows/release.yml)
+[](https://github.com/ThreeMammals/Ocelot/actions/workflows/develop.yml)
+[](https://app.readthedocs.org/projects/ocelot/builds/?version__slug=latest)
+[](https://coveralls.io/github/ThreeMammals/Ocelot?branch=main)
+[](https://github.com/ThreeMammals/Ocelot/blob/main/LICENSE.md)
+[](https://www.nuget.org/packages/Ocelot/ "Download Ocelot from NuGet.org")
+[](https://www.nuget.org/packages/Ocelot/ "Total Ocelot downloads from NuGet.org")
## About
Ocelot is a .NET [API gateway](https://www.bing.com/search?q=API+gateway).
@@ -74,11 +75,11 @@ You can see what we are working on in the [backlog](https://github.com/ThreeMamm
## Contributing
We love to receive contributions from the community, so please keep them coming.
-Pull requests, issues, and commentary welcome! 
+Pull requests, issues, and commentary welcome!
Please complete the relevant [template](https://github.com/ThreeMammals/Ocelot/tree/main/.github) for [issues](https://github.com/ThreeMammals/Ocelot/blob/main/.github/ISSUE_TEMPLATE.md) and [pull requests](https://github.com/ThreeMammals/Ocelot/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
Sometimes it's worth getting in touch with us to [discuss](https://github.com/ThreeMammals/Ocelot/discussions) changes before doing any work in case this is something we are already doing or it might not make sense.
-We can also give advice on the easiest way to do things
+We can also give advice on the easiest way to do things
Finally, we mark all existing issues as [![label: help wanted][~helpwanted]](https://github.com/ThreeMammals/Ocelot/labels/help%20wanted)
[![label: small effort][~smalleffort]](https://github.com/ThreeMammals/Ocelot/labels/small%20effort)
@@ -86,7 +87,7 @@ Finally, we mark all existing issues as [![label: help wanted][~helpwanted]](htt
[![label: large effort][~largeeffort]](https://github.com/ThreeMammals/Ocelot/labels/large%20effort). [^6]
If you want to contribute for the first time, we suggest looking at a [![label: help wanted][~helpwanted]](https://github.com/ThreeMammals/Ocelot/labels/help%20wanted)
[![label: small effort][~smalleffort]](https://github.com/ThreeMammals/Ocelot/labels/small%20effort)
-[![label: good first issue][~goodfirstissue]](https://github.com/ThreeMammals/Ocelot/labels/good%20first%20issue)
+[![label: good first issue][~goodfirstissue]](https://github.com/ThreeMammals/Ocelot/labels/good%20first%20issue)
[~helpwanted]: https://img.shields.io/badge/-help%20wanted-128A0C.svg
[~smalleffort]: https://img.shields.io/badge/-small%20effort-fef2c0.svg
@@ -96,8 +97,8 @@ If you want to contribute for the first time, we suggest looking at a [![label:
### Notes
[^1]: Ocelot does not directly support [GraphQL](https://graphql.org/). Developers can easily integrate the [GraphQL for .NET](https://github.com/graphql-dotnet/graphql-dotnet) library.
-[^2]: Ocelot supports [Consul](https://www.consul.io/), [Netflix Eureka](https://www.nuget.org/packages/Steeltoe.Discovery.Eureka), [Service Fabric](https://azure.microsoft.com/en-us/products/service-fabric/) service discovery providers, as well as special modes like [Dynamic Routing](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#dynamic-routing) and [Custom Providers](/ThreeMammals/Ocelot/blob/main/docs/features/servicediscovery.rst#custom-providers).
-[^3]: Retry policies only via [Polly](/App-vNext/Polly) library.
-[^4]: Starting with version [21.0](https://github.com/ThreeMammals/Ocelot/releases/tag/21.0.0), the solution's code base supports [Multitargeting](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-multitargeting-overview) as SDK-style projects. It should be easier for teams to migrate to the currently supported [.NET 8 and 9](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#lifecycle) frameworks. Also, new features will be available for all .NET SDKs that we support via multitargeting. Find out more here: [Target frameworks in SDK-style projects](https://learn.microsoft.com/en-us/dotnet/standard/frameworks)
+[^2]: Ocelot supports the following service discovery providers: (**1**) [Consul](https://www.consul.io) through the [Ocelot.Provider.Consul](https://www.nuget.org/packages/Ocelot.Provider.Consul) extension package, (**2**) [Kubernetes](https://kubernetes.io) via the [Ocelot.Provider.Kubernetes](https://www.nuget.org/packages/Ocelot.Provider.Kubernetes) extension package, and (**3**) [Netflix Eureka](https://spring.io/projects/spring-cloud-netflix), which utilizes the [Steeltoe.Discovery.Eureka](https://www.nuget.org/packages/Steeltoe.Discovery.Eureka) package referenced within the [Ocelot.Provider.Eureka](https://www.nuget.org/packages/Ocelot.Provider.Eureka) extension package. Additionally, Ocelot supports (**4**) Azure [Service Fabric](https://azure.microsoft.com/en-us/products/service-fabric/) for service discovery, along with special modes such as [Dynamic Routing](https://ocelot.readthedocs.io/en/latest/features/servicediscovery.html#dynamic-routing) and [Custom Providers](https://ocelot.readthedocs.io/en/latest/features/servicediscovery.html#custom-providers).
+[^3]: Retry policies only via [Polly](https://github.com//App-vNext/Polly) library referenced within the [Ocelot.Provider.Polly](https://www.nuget.org/packages/Ocelot.Provider.Polly) extension package.
+[^4]: Starting with version [21](https://github.com/ThreeMammals/Ocelot/releases/tag/21.0.0) and higher, the solution's code base supports [Multitargeting](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-multitargeting-overview) as SDK-style projects. It should be easier for teams to migrate to the currently supported [.NET 8 and 9](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#lifecycle) frameworks. Also, new features will be available for all .NET SDKs that we support via multitargeting. Find out more here: [Target frameworks in SDK-style projects](https://learn.microsoft.com/en-us/dotnet/standard/frameworks)
[^5]: [Ocelot Guru](https://gurubase.io/g/ocelot) is an unofficial tool to get answers regarding Ocelot: please consider it an advanced search tool. Thus, we have an official [Questions & Answers](https://github.com/ThreeMammals/Ocelot/discussions/categories/q-a) category in the [Discussions](https://github.com/ThreeMammals/Ocelot/discussions) space.
[^6]: See all [labels](https://github.com/ThreeMammals/Ocelot/issues/labels) for the repository, which are useful for searching and filtering.
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
index 5f0ea652b..669380160 100644
--- a/ReleaseNotes.md
+++ b/ReleaseNotes.md
@@ -1 +1,57 @@
-## Technical Release
+## Upgrade to .NET 9 (TFM `net9.0`, version 24.0) aka [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) release
+> Milestone: [.NET 9](https://github.com/ThreeMammals/Ocelot/milestone/11)
+> Codenamed: [.NET 9](https://devblogs.microsoft.com/dotnet/announcing-dotnet-9/)
+> Read the Docs: [Ocelot 24.0](https://ocelot.readthedocs.io/en/{0}/) with [PDF](https://ocelot.readthedocs.io/_/downloads/en/{0}/pdf/)
+> Target Framework Monikers: `net8.0`, `net9.0`
+
+### :information_source: About
+On November 12th, 2024, the [.NET team](https://devblogs.microsoft.com/dotnet/author/dotnet) announced the release of the [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) framework:
+
+* .NET Blog: [Announcing .NET 9](https://devblogs.microsoft.com/dotnet/announcing-dotnet-9/)
+
+This major release upgrades [Ocelot](https://www.nuget.org/packages/Ocelot) package [TFMs](https://learn.microsoft.com/en-us/dotnet/standard/frameworks#latest-versions) to `net9.0` in addition to the current `net8.0`. Thus, the current Ocelot [supported frameworks](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core#lifecycle) are .NET 8 LTS and .NET 9 STS. According to the [.NET Support Policy](https://dotnet.microsoft.com/en-us/platform/support/policy), the Ocelot team has discontinued support of .NET 6 and .NET 7 by providing the version [23.4.3](https://github.com/ThreeMammals/Ocelot/releases/tag/23.4.3) which targets those .NET versions.
+
+### :new: What's New?
+
+- [DevOps](https://github.com/ThreeMammals/Ocelot/labels/DevOps): The CI/CD infrastructure was migrated from CircleCI to GitHub Actions by @raman-m.
+
+ #### Official Notice to the Community Regarding CircleCI
+
+ Ocelot's previous CI/CD provider, [CircleCI](https://circleci.com/), facilitated professional and seamless development, build processes, and delivery of Ocelot versions for seven years, starting in [March 2018](https://github.com/ThreeMammals/Ocelot/pull/283). But last year, in January 2025, after patching Ocelot with version [23.4.3](https://github.com/ThreeMammals/Ocelot/releases/tag/23.4.3), our team encountered legal issues related to [CircleCI](https://circleci.com/) Co's policies, leading to this CI/CD provider stopping the build process for the [Ocelot project](https://app.circleci.com/pipelines/github/ThreeMammals/Ocelot). This legal issue and technical incident were unforeseen on our part because Ocelot is _open-source software_ (OSS), and forcibly stopping the project's build process and blocking accounts appears to be an unfortunate breach of OSS principles. We strongly believe that any developer or user, from any country, should be able to use software providers that support the OSS movement by offering free or other cost-free plans and serving the accounts of these users, OSS teams, and OSS projects 24/7, 365 days a year. We consider this legal issue and the resulting technical incidents involving CircleCI to be a serious breach of OSS principles and an act of discrimination against Ocelot users, developers, and customers who rely on Ocelot OSS, ultimately causing delays to the current release. **As a team, we do not recommend using CircleCI for OSS projects**, as there is no guarantee that these projects will not face discrimination from this U.S. company.
+
+ For all developers, team leads, architects, and managers of any OSS projects—at least on GitHub—we recommend utilizing the built-in GitHub Actions CI/CD infrastructure. Since its founding, GitHub has supported OSS projects. Today, GitHub provides 2,000 minutes of free CI/CD build time per month for OSS repositories (public repos). Also, we strongly believe that GitHub will never violate its OSS policies without a notice period, nor fail to inform owners and maintainers that certain policies must be met by Ocelot's owners. In addition, we want to acknowledge that we are monitoring U.S. government regulations. Unfortunately, we must state that some GitHub products are unavailable in certain countries, even if the project is OSS and GitHub claims these products are free for OSS. Since the Ocelot team does not utilize these non-critical products (we prefer to energize our brains rather than rely on AI-driven products), and since the Ocelot project is currently well-served by GitHub Co, the Ocelot team affirms that Ocelot will remain on GitHub as long as its OSS-friendly policies continue. As a team, we hope that GitHub will never enforce extra rules on our project or other OSS projects.
+ Regardless, we remain on GitHub!
+
+ #### Technical Information
+
+ Starting from version [24.0](https://github.com/ThreeMammals/Ocelot/releases/tag/{0}), all pull requests, development commits, and releases will be built using [GitHub Actions](https://docs.github.com/en/actions) workflows. We currently have [three workflows](https://github.com/ThreeMammals/Ocelot/tree/main/.github/workflows): one for pull requests ([PR](https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/pr.yml)), one for the `develop` branch ([Develop](https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/develop.yml)), and one for the `main` branch ([Release](https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/release.yml)).
+
+ The [PR](https://github.com/ThreeMammals/Ocelot/blob/main/.github/workflows/pr.yml) workflow will track code coverage using [Coveralls](https://coveralls.io/). After opening a pull request or submitting a new commit to a pull request, [Coveralls](https://coveralls.io) will publish a short message with the current code coverage once the top commit is built. Considering that [Coveralls](https://coveralls.io) retains the entire history but does not fail the build if coverage falls below the threshold, all workflows have a built-in 80% threshold, applied internally within the `build-cake` job, particularly during the "Cake Build" step-action. If the code coverage of a newly opened pull request drops below the 80% threshold, the `build-cake` job will fail, logging an appropriate message in the "Cake Build" step. For your information, the current code coverage of the Ocelot project is around 85-86%. The coverage threshold is subject to change in upcoming releases. All Coveralls builds can be viewed by navigating to the [ThreeMammals/Ocelot](https://coveralls.io/github/ThreeMammals/Ocelot) project on Coveralls.io.
+
+### :up: What's Updated?
+
+- **[Core](https://github.com/ThreeMammals/Ocelot/labels/Core)**:
+ The main [Ocelot](https://www.nuget.org/packages/Ocelot) package and all [extension](https://www.nuget.org/profiles/ThreeMammals) packages [reference](https://github.com/search?q=repo%3AThreeMammals%2FOcelot%20%3CTargetFrameworks%3E&type=code) `net8.0` and `net9.0` target framework monikers (TFMs). Refer to [TargetFrameworks](https://github.com/search?q=repo%3AThreeMammals%2FOcelot%20%3CTargetFrameworks%3E&type=code) to verify this. The `net6.0` and `net7.0` TFMs have been removed. If your project still relies on these outdated TFMs, please continue using version [23.4.3](https://github.com/ThreeMammals/Ocelot/releases/tag/23.4.3).
+
+- **[Authentication](https://ocelot.readthedocs.io/en/{0}/features/authentication.html)**:
+ Testing of [Identity Server Bearer Tokens](https://ocelot.readthedocs.io/en/{0}/features/authentication.html#identity-server-bearer-tokens) functionality was stopped due to [vulnerabilities](https://github.com/ThreeMammals/Ocelot/security/dependabot) reported by Dependabot, specifically the "[IdentityServer Open Redirect vulnerability](https://github.com/ThreeMammals/Ocelot/security/dependabot?q=is%3Aclosed+IdentityServer)" security issue. More technical details were provided in the [23.4.3](https://github.com/ThreeMammals/Ocelot/releases/tag/23.4.3) release notes, where we notified the community. Ultimately, issue #2218 was addressed via pull request #2274.
+ >**Note**: In upcoming releases, we plan to utilize the [ASP.NET Core Identity](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/identity) framework in our [acceptance testing](https://github.com/ThreeMammals/Ocelot/tree/main/test/Ocelot.AcceptanceTests) project to align with .NET industry standards. As a result, we intend to replace the [IdentityServer4](https://github.com/DuendeArchive/IdentityServer4) library with [ASP.NET Core Identity](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/identity), which also supports Bearer tokens, also known as `JwtBearerHandler` from the [Microsoft.AspNetCore.Authentication.JwtBearer](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.authentication.jwtbearer) namespace.
+
+- **[Administration](https://ocelot.readthedocs.io/en/{0}/features/administration.html)**:
+ The [Ocelot.Administration](https://www.nuget.org/packages/Ocelot.Administration) extension package has been renamed to [Ocelot.Administration.IdentityServer4](https://github.com/ThreeMammals/Ocelot.Administration.IdentityServer4) (it is scheduled for deprecation) to address all [IdentityServer4](https://github.com/DuendeArchive/IdentityServer4)-related [vulnerabilities](https://github.com/ThreeMammals/Ocelot/security/dependabot) (issue #2218). The [package's source code](https://github.com/ThreeMammals/Ocelot/tree/release/23.4/src/Ocelot.Administration) has been moved out of the Ocelot repository (pull request #2274) and transferred to the newly created [Ocelot.Administration.IdentityServer4](https://github.com/ThreeMammals/Ocelot.Administration.IdentityServer4) repository.
+ >**Note**: Currently, the [Administration](https://ocelot.readthedocs.io/en/{0}/features/administration.html) feature is solely based on the [IdentityServer4 package](https://github.com/ThreeMammals/Ocelot/blob/release/23.4/src/Ocelot.Administration/Ocelot.Administration.csproj#L38), whose [repository](https://github.com/IdentityServer/IdentityServer4) was archived by its owner on July 31, 2024. The Ocelot team will deprecate the new [Ocelot.Administration.IdentityServer4](https://github.com/ThreeMammals/Ocelot.Administration.IdentityServer4) extension package after the current Ocelot release; however, the repository will not be archived, allowing for potential patches in the future.
+
+- **[Kubernetes](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html)**:
+ 1. Answered question #2256 on "How to provide a host to the Kubernetes service discovery provider?"
+ Unfortunately, in the [Kubernetes](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html) chapter, it was unclear to users how to define a K8s endpoint host in the [Configuration](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html#configuration) due to the implicit reuse of `KubeClient`, which is created from the pod account during [Install](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html#install)-ation. As a team, we decided to add the new [AddKubernetes(Action<KubeClientOptions>) method](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html#addkubernetes-action-kubeclientoptions-method), which handles different user scenarios. It is now possible to provide manually configured `KubeClientOptions` in C# during [Install](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html#install)-ation, but users can also reuse `ServiceDiscoveryProvider` options from the global [configuration](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html#configuration), including the `Host` option to construct the [kubernetes](https://ocelot.readthedocs.io/en/{0}/features/kubernetes.html) endpoint address. The new overloaded `AddKubernetes(Action)` method was implemented in pull request #2257.
+ 2. In the [Ocelot.Provider.Kubernetes](https://www.nuget.org/packages/Ocelot.Provider.Kubernetes/) extension package, the `KubeClient` dependency library version was upgraded to `3.0.x`, which requires .NET 8.0 and .NET 9.0 TFMs for the current Ocelot version [24.0](https://github.com/ThreeMammals/Ocelot/releases/tag/24.0.0). `KubeClient` v3 was internally reviewed and released specifically to meet Ocelot's needs for this release. Thanks to Adam Friedman (@tintoy) for his collaboration! This package upgrade was implemented in pull request #2266.
+
+- **[Sample](https://github.com/ThreeMammals/Ocelot/labels/sample)**:
+ The learning [Samples](https://github.com/ThreeMammals/Ocelot/tree/main/samples) projects were reviewed, rewritten, and refactored due to issue #1912. The community brought to our attention that the documentation and [samples](https://github.com/ThreeMammals/Ocelot/tree/main/samples) were outdated, as .NET 8 allows the `Program.cs` file to be minimized using the "[Top-level statements](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/program-structure/top-level-statements)" feature. This was ultimately addressed in pull requests #2244 and #2258.
+
+### :notebook: Documentation Summary
+Due to the major version increase to v24, all documentation chapters were reviewed to improve readability, eliminate ambiguity, provide more useful tables and data schemas, update code snippets with the syntax of [Top-level statements](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/program-structure/top-level-statements), and add handy samples, among other enhancements. The entire documentation is designed to be truly professional for senior developers while remaining easy to read for junior developers and newcomers who are starting to use the Ocelot gateway.
+
+We believe that Ocelot students will ask fewer questions in 2025 :wink:
+For students, we always recommend finding answers in [Q&A](https://github.com/ThreeMammals/Ocelot/discussions/categories/q-a) category first. Honestly, it is advised to read existing discussions before opening a new question in repo [discussions](https://github.com/ThreeMammals/Ocelot/discussions).
+For true Ocelot patriots, we have added a [README link](https://github.com/ThreeMammals/Ocelot?tab=readme-ov-file#documentation) to the smart [Ocelot AI Guru](https://gurubase.io/g/ocelot) assistant, which is always ready to answer any of your questions. Feel free to explore and interact with it! :blush:
diff --git a/build.cake b/build.cake
index fcbbb2ed8..c2008f91a 100644
--- a/build.cake
+++ b/build.cake
@@ -14,7 +14,7 @@ using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
-const bool IsTechnicalRelease = false;
+bool IsTechnicalRelease = false;
const string Release = "Release"; // task name, target, and Release config name
const string PullRequest = "PullRequest"; // task name, target, and PullRequest config name
const string AllFrameworks = "net8.0;net9.0";
@@ -277,7 +277,7 @@ Task("CreateReleaseNotes")
var place = Place(log.Count);
return HonorForDeletions(place, contributor.Contributor, group.Commits, contributor.Files, contributor.Insertions, contributor.Deletions);
});
- Information("---==< TOP Contributors >==---");
+ Information("------==< TOP Contributors >==------");
Information(string.Join(NL, topContributors));
// local helpers
@@ -392,20 +392,20 @@ Task("CreateReleaseNotes")
}
return log;
} // END of IterateCommits
- // releaseNotes.Add("### Honoring :medal_sports: aka Top Contributors :clap:");
- // releaseNotes.AddRange(topContributors.Take(3)); // Top 3 only, disabled 'breaker' logic
- // releaseNotes.Add("");
- // releaseNotes.Add("### Starring :star: aka Release Influencers :bowtie:");
- // releaseNotes.AddRange(starring);
- // releaseNotes.Add("");
- // releaseNotes.Add($"### Features in Release {releaseVersion}");
- // releaseNotes.Add("");
- // releaseNotes.Add("Logbook
");
- // releaseNotes.Add("");
- // var commitsHistory = GitHelper($"log --no-merges --date=format:\"%A, %B %d at %H:%M\" --pretty=format:\"- %h by **%aN** on %ad →%n %s\" {lastRelease}..HEAD");
- // releaseNotes.AddRange(commitsHistory);
- // releaseNotes.Add("Logbook
");
+ releaseNotes.Add("");
+ var commitsHistory = GitHelper($"log --no-merges --date=format:\"%A, %B %d at %H:%M\" --pretty=format:\"- %h by **%aN** on %ad →%n %s\" {lastRelease}..HEAD");
+ releaseNotes.AddRange(commitsHistory);
+ releaseNotes.Add("Table of Contents
`
.. toctree::
:maxdepth: 2
@@ -67,7 +71,8 @@ We adhere to a :doc:`../building/devprocess` which is a part of :doc:`../buildin
:maxdepth: 3
:caption: Building Ocelot
- building/overview
+ building/building
building/devprocess
building/releaseprocess
+:htm:``
diff --git a/docs/introduction/bigpicture.rst b/docs/introduction/bigpicture.rst
index 632bf688d..0dd71ff79 100644
--- a/docs/introduction/bigpicture.rst
+++ b/docs/introduction/bigpicture.rst
@@ -4,10 +4,11 @@ Big Picture
Ocelot is aimed at people using .NET running a microservices (service-oriented) architecture (aka SOA) that need a unified point of entry into their system.
However it will work with anything that speaks HTTP(S) and run on any platform that `ASP.NET Core `_ supports.
-.. TODO Decide what to do with this paragraph?..
-.. In particular we want easy integration with `IdentityServer `_ reference and `Bearer `_ tokens.
-.. We have been unable to find this in our current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens.
-.. We would rather use the IdentityServer code that already exists to do this.
+..
+ TODO Decide what to do with this paragraph?..
+ In particular we want easy integration with `IdentityServer `_ reference and `Bearer `_ tokens.
+ We have been unable to find this in our current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens.
+ We would rather use the IdentityServer code that already exists to do this.
Ocelot consists of a series of ASP.NET Core `middlewares `_ arranged in a specific order.
@@ -21,22 +22,23 @@ That is basically it with a bunch of other features!
The following are configurations that you use when deploying Ocelot.
Basic Implementation
-^^^^^^^^^^^^^^^^^^^^
+--------------------
.. image:: ../images/OcelotBasic.jpg
-.. TODO Do not advertise the product because of non-OSS status
-.. With IdentityServer
-.. ^^^^^^^^^^^^^^^^^^^
-.. .. image:: ../images/OcelotIndentityServer.jpg
+..
+ TODO Do not advertise the product because of non-OSS status
+ With IdentityServer
+ ^^^^^^^^^^^^^^^^^^^
+ .. image:: ../images/OcelotIndentityServer.jpg
Multiple Instances
-^^^^^^^^^^^^^^^^^^
+------------------
.. image:: ../images/OcelotMultipleInstances.jpg
With Consul
-^^^^^^^^^^^
+-----------
.. image:: ../images/OcelotMultipleInstancesConsul.jpg
With Service Fabric
-^^^^^^^^^^^^^^^^^^^
+-------------------
.. image:: ../images/OcelotServiceFabric.jpg
diff --git a/docs/introduction/gotchas.rst b/docs/introduction/gotchas.rst
index 515b0e2f2..68d0553ae 100644
--- a/docs/introduction/gotchas.rst
+++ b/docs/introduction/gotchas.rst
@@ -11,7 +11,7 @@ Please review deployment and web hosting common user scenarios below depending o
IIS
---
- | Repository Label: |image-IIS|
+ | Repository Label: |image-IIS| `IIS `_
| Microsoft Learn: `Host ASP.NET Core on Windows with IIS `_
We **do not** recommend to deploy Ocelot app to IIS environments, but if you do, keep in mind the gotchas below.
@@ -41,7 +41,7 @@ Probably you will find a ready solution by Ocelot community members.
Kestrel
-------
- | Repository Label: |image-Kestrel|
+ | Repository Label: |image-Kestrel| `Kestrel `_
| Microsoft Learn: `Kestrel web server in ASP.NET Core `_
We **do** recommend to deploy Ocelot app to self-hosting environments, aka Kestrel vs Docker.
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
index 00961fa3f..c903b09b7 100644
--- a/docs/releasenotes.rst
+++ b/docs/releasenotes.rst
@@ -4,7 +4,6 @@
.. _24.0.0: https://github.com/ThreeMammals/Ocelot/releases/tag/24.0.0
.. _.NET 9: https://dotnet.microsoft.com/en-us/download/dotnet/9.0
.. _Ocelot: https://www.nuget.org/packages/Ocelot
-
.. role:: htm(raw)
:format: html
@@ -16,40 +15,15 @@ Welcome
Welcome to the Ocelot `24.0`_ documentation!
-It is recommended to read all :ref:`release-notes` if you have deployed the Ocelot app in a production environment and are planning to upgrade to major or patched versions.
-
-.. The major version `23.4.0`_ includes several patches, the history of which is provided below.
-
-.. .. admonition:: Patches
-
-.. - `23.4.1`_, on Nov 22, 2024: Routing patch.
-.. - `23.4.2`_, on Nov 27, 2024: End of .NET 6/7 Support patch.
+It is recommended to read all :ref:`release-notes` if you have deployed the Ocelot app in a production environment and are planning to upgrade to major, minor or patched versions.
.. _release-notes:
Release Notes
-------------
-| Release Tag: `24.0.0`_
-| Release Codename: `.NET 9`_
-
- .. :htm:`With release jokes:
`
-
- .. - **for men**: Wearing a cap with the `MAGA slogan `_ is encouraged when visiting McDonald's.
- .. - **for women**: Donald is fond of caps, particularly the `MAGA cap `_, and it's amusing to see children's reactions when `We Ask Kids How Mr.D is Doing `_?
- .. - **for black men**: Here are some highlights of Donald's antics aka Mr. D:
-
- .. | 1 `Mr. D stops to retrieve Marine's hat `_
- .. | 2 `M-A-G-A caps take flight `_
- .. | 3 `Mr. D Dances To 'YMCA' `_
- .. | 4 `Elon is more than just a MAGAr `_
- .. | 5 `Mr. D looks for a job at McDonald's in 2024 `_
- .. | lastly, `Mr. D serves customers at McDonald's Drive-Thru `_
-
- .. :htm:`