From 7399b6ef1f206af730fe409ffed75271b8040406 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 09:59:56 -0700 Subject: [PATCH 01/14] Update support.md --- Odata-docs/resources/support.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Odata-docs/resources/support.md b/Odata-docs/resources/support.md index 66db1c41..35769b77 100644 --- a/Odata-docs/resources/support.md +++ b/Odata-docs/resources/support.md @@ -16,3 +16,7 @@ Code related issues in the OData .NET libraries can be reported by creating GitH ## Questions General question on library usage should be posted on [stackoverflow](https://stackoverflow.com/questions/tagged/odata) and tagged with `odata` tag. + +## Supported library version lifecycle + +Resources about the lifecycle of individual library versions can be found [here](./version-lifecycle.md). From 193b1ded840d8f7a45090afd5310e97b9b6f7381 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:00:30 -0700 Subject: [PATCH 02/14] Create version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Odata-docs/resources/version-lifecycle.md diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md new file mode 100644 index 00000000..c0979d89 --- /dev/null +++ b/Odata-docs/resources/version-lifecycle.md @@ -0,0 +1 @@ +# Supported library version lifecycle From 45aad263eb7a706e56eaf192e72a32946d145988 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:01:52 -0700 Subject: [PATCH 03/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index c0979d89..34a469c9 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -1 +1,9 @@ -# Supported library version lifecycle +--- +title : "Supported library version lifecycle" +author: unchase +ms.date: 7/1/2019 +--- + +# Accidental breaking change releases + +Nuget packages for From 6f31f57b02a39a75ae244f9d78b298fb5c696f48 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:07:53 -0700 Subject: [PATCH 04/14] Update TOC.yml --- Odata-docs/TOC.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Odata-docs/TOC.yml b/Odata-docs/TOC.yml index 92a485b2..d3358cfb 100644 --- a/Odata-docs/TOC.yml +++ b/Odata-docs/TOC.yml @@ -492,6 +492,8 @@ href: /odata/resources/support - name: Roadmap href: /odata/resources/roadmap + - name: Supported library version lifecycle + href: /odata/resources/version-lifecycle - name: Changelog items: - name: OData lib changes From e490e3d7ed077b947543ac6c4f56603245ccfd0c Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:08:17 -0700 Subject: [PATCH 05/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index 34a469c9..1270ae4e 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -1,7 +1,7 @@ --- title : "Supported library version lifecycle" -author: unchase -ms.date: 7/1/2019 +author: gdebruin +ms.date: 9/25/2023 --- # Accidental breaking change releases From 9daa4ce608950779e9b22039de2ec7a1c1323a97 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:09:44 -0700 Subject: [PATCH 06/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index 1270ae4e..8f859ea0 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -6,4 +6,5 @@ ms.date: 9/25/2023 # Accidental breaking change releases -Nuget packages for +Nuget packages published by the [OData nuget profile](https://www.nuget.org/profiles/OData) will take the following actions to mitigate the accidental release of a library version that introduces a breaking change: +1. From 53f74555ebb0316aa074886fb4f61363a1af6721 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:14:28 -0700 Subject: [PATCH 07/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index 8f859ea0..f4245907 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -7,4 +7,6 @@ ms.date: 9/25/2023 # Accidental breaking change releases Nuget packages published by the [OData nuget profile](https://www.nuget.org/profiles/OData) will take the following actions to mitigate the accidental release of a library version that introduces a breaking change: -1. +1. The package will be marked deprecated. +2. The deprecated package will specify an alternate version to install (usually `Latest`) with a message indicating what the breaking change was. +3. The package will be unlisted. From a1d9369dcbcb45b035d127d821d81ac8e8a61624 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 21:35:50 -0700 Subject: [PATCH 08/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index f4245907..ce1e10de 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -6,7 +6,7 @@ ms.date: 9/25/2023 # Accidental breaking change releases -Nuget packages published by the [OData nuget profile](https://www.nuget.org/profiles/OData) will take the following actions to mitigate the accidental release of a library version that introduces a breaking change: +Nuget packages published by the [OData nuget profile](https://www.nuget.org/profiles/OData) will have the following actions taken to mitigate the accidental release of a library version that introduces a breaking change: 1. The package will be marked deprecated. 2. The deprecated package will specify an alternate version to install (usually `Latest`) with a message indicating what the breaking change was. 3. The package will be unlisted. From bb5f1ecfb2d1c3c9fec7942fc74f0532ca50854a Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 21:38:27 -0700 Subject: [PATCH 09/14] Update version-lifecycle.md --- Odata-docs/resources/version-lifecycle.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Odata-docs/resources/version-lifecycle.md b/Odata-docs/resources/version-lifecycle.md index ce1e10de..54dfeaf0 100644 --- a/Odata-docs/resources/version-lifecycle.md +++ b/Odata-docs/resources/version-lifecycle.md @@ -1,5 +1,6 @@ --- title : "Supported library version lifecycle" +description: "This section describes what support policy customers can expect for the lifecycle of different OData library versions." author: gdebruin ms.date: 9/25/2023 --- From 584ac468ff6982312d23d290297c01d53a042078 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 21:47:46 -0700 Subject: [PATCH 10/14] Update TOC.yml --- Odata-docs/TOC.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Odata-docs/TOC.yml b/Odata-docs/TOC.yml index d3358cfb..ea845e46 100644 --- a/Odata-docs/TOC.yml +++ b/Odata-docs/TOC.yml @@ -291,7 +291,7 @@ - name: Resource (Complex & Entity) Value href: /odata/odatalib/resource-value - name: Using Utf8JsonWriter for better performance - href: /odata/odatalib/using-utf8jsonwriter-for-better-performance + href: /odata/odatalib/using-ut8jsonwriter-for-better-performance - name: Entity Data Model (EDM) items: # - name: Model Building From fb009033b36134237591e0ff306a1b52cfae1a92 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 21:49:14 -0700 Subject: [PATCH 11/14] Update TOC.yml --- Odata-docs/TOC.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Odata-docs/TOC.yml b/Odata-docs/TOC.yml index ea845e46..d3358cfb 100644 --- a/Odata-docs/TOC.yml +++ b/Odata-docs/TOC.yml @@ -291,7 +291,7 @@ - name: Resource (Complex & Entity) Value href: /odata/odatalib/resource-value - name: Using Utf8JsonWriter for better performance - href: /odata/odatalib/using-ut8jsonwriter-for-better-performance + href: /odata/odatalib/using-utf8jsonwriter-for-better-performance - name: Entity Data Model (EDM) items: # - name: Model Building From 11531d8dd3219b7de9af42ab970badccfc02a875 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 21:49:46 -0700 Subject: [PATCH 12/14] Rename using-ut8jsonwriter-for-better-performance.md to using-utf8jsonwriter-for-better-performance.md --- ...rmance.md => using-utf8jsonwriter-for-better-performance.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename Odata-docs/odatalib/v7/{using-ut8jsonwriter-for-better-performance.md => using-utf8jsonwriter-for-better-performance.md} (99%) diff --git a/Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md b/Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md similarity index 99% rename from Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md rename to Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md index 4445578a..2361409e 100644 --- a/Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md +++ b/Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md @@ -55,4 +55,4 @@ You can provide a different `JavaScriptEncoder`. Instead of injecting `DefaultSt IStreamBasedJsonWriterFactory factory = new DefaultStreamBasedJsonWriterFactory(JavaScriptEncoder.UnsafeRelaxedJsonEscaping); ``` -Note that there’s no built-in JavaScriptEncoder that exactly matches the escaping rules of `Microsoft.OData.Core`’s default `JsonWriter`. The raw output of the two writers will be different. But if the client is [standards-compliant](https://www.ietf.org/rfc/rfc4627.txt), this should not be a problem. Nevertheless, this is something you should take into consideration before adopting the new writer. In general, you should not be highly dependent on a particular escaping output because the internal implementation may change from one version of .NET to another (See relevant discussions [here](https://github.com/dotnet/runtime/issues/70419), [here](https://github.com/dotnet/runtime/issues/54193) and [here](https://github.com/dotnet/runtime/issues/1564#issuecomment-504780719)). \ No newline at end of file +Note that there’s no built-in JavaScriptEncoder that exactly matches the escaping rules of `Microsoft.OData.Core`’s default `JsonWriter`. The raw output of the two writers will be different. But if the client is [standards-compliant](https://www.ietf.org/rfc/rfc4627.txt), this should not be a problem. Nevertheless, this is something you should take into consideration before adopting the new writer. In general, you should not be highly dependent on a particular escaping output because the internal implementation may change from one version of .NET to another (See relevant discussions [here](https://github.com/dotnet/runtime/issues/70419), [here](https://github.com/dotnet/runtime/issues/54193) and [here](https://github.com/dotnet/runtime/issues/1564#issuecomment-504780719)). From 7fc0866e31804fe7dd05d18ff8eb14d723e10a4c Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 22:01:59 -0700 Subject: [PATCH 13/14] Create .openpublishing.redirection.json --- .openpublishing.redirection.json | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .openpublishing.redirection.json diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json new file mode 100644 index 00000000..c3e9d13c --- /dev/null +++ b/.openpublishing.redirection.json @@ -0,0 +1,9 @@ +{ + "redirections": [ + { + "source_path": "Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md", + "redirect_url": "/odata/odatalib/using-ut8jsonwriter-for-better-performance", + "redirect_document_id": true + } + ] +} From 549d67eaca654409e7c4533dd3d53864638ba2d3 Mon Sep 17 00:00:00 2001 From: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com> Date: Tue, 24 Oct 2023 22:04:20 -0700 Subject: [PATCH 14/14] Update .openpublishing.redirection.json --- .openpublishing.redirection.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index c3e9d13c..36676921 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -1,8 +1,8 @@ { "redirections": [ { - "source_path": "Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md", - "redirect_url": "/odata/odatalib/using-ut8jsonwriter-for-better-performance", + "source_path": "Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md", + "redirect_url": "/odata/odatalib/using-utf8jsonwriter-for-better-performance", "redirect_document_id": true } ]