From 531766878cd6451a28d5ff3ce01b675d3b936505 Mon Sep 17 00:00:00 2001
From: Thomas Farr <tsfarr@amazon.com>
Date: Wed, 24 Apr 2024 11:44:29 +1200
Subject: [PATCH] Add link in README and add TOC

Signed-off-by: Thomas Farr <tsfarr@amazon.com>
---
 .github/bump-version.sh |  4 +++-
 README.md               |  6 ++++++
 UPGRADING.md            | 43 ++++++++++++++++++++++++++++++++++++++---
 3 files changed, 49 insertions(+), 4 deletions(-)

diff --git a/.github/bump-version.sh b/.github/bump-version.sh
index c770910145..54e548ee04 100644
--- a/.github/bump-version.sh
+++ b/.github/bump-version.sh
@@ -28,4 +28,6 @@ GLOBAL_JSON=$(jq \
 	global.json)
 echo "$GLOBAL_JSON" > global.json
 
-sed -i'' -E "s/<(Current(Assembly(File)?)?Version)>([0-9]+\.){2}[0-9]+<\/\1>/<\1>$VERSION<\/\1>/" Directory.Build.props
+gsed -i'' -E "s/<(Current(Assembly(File)?)?Version)>[0-9]+\.[0-9]+\.[0-9]+<\/\1>/<\1>$VERSION<\/\1>/" Directory.Build.props
+
+gsed -i'' -E "s/(next release of opensearch\-net, which should be \*\*)[0-9]+\.[0-9]+\.[0-9]+(\*\*\.)/\1$VERSION\2/" README.md
diff --git a/README.md b/README.md
index d300411218..81357c0ca8 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@
 
 - [OpenSearch .NET Client](#opensearch-net-client)
   - [Welcome!](#welcome)
+  - [Stable Release](#stable-release)
   - [Project Resources](#project-resources)
   - [OpenSearch.Client](#opensearch-client)
   - [Getting Started](#getting-started)
@@ -24,6 +25,11 @@
 
 **OpenSearch.Client** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of elasticsearch-net high level client NEST licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/).
 
+## Stable Release
+You're reading the documentation for the next release of opensearch-net, which should be **2.0.0**.
+Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+The current stable release is [1.7.1](https://github.com/opensearch-project/opensearch-net/blob/v1.7.1/README.md).
+
 ## Project Resources
 
 * [Project Website](https://opensearch.org/)
diff --git a/UPGRADING.md b/UPGRADING.md
index 28d191b44d..bba5b668be 100644
--- a/UPGRADING.md
+++ b/UPGRADING.md
@@ -1,8 +1,45 @@
-# Upgrade Guidance
-## 1.x.y to 2.0.0
+<!-- TOC -->
+* [Upgrading OpenSearch.Net & OpenSearch.Client](#upgrading-opensearchnet--opensearchclient)
+  * [1.x.y to 2.0.0](#1xy-to-200)
+    * [OpenSearch.Net](#opensearchnet)
+      * [General](#general)
+      * [Cat.Indices Action](#catindices-action)
+      * [Cat.Master Action](#catmaster-action)
+      * [Cat.Plugins Action](#catplugins-action)
+      * [Cat.Recovery Action](#catrecovery-action)
+      * [Cluster.ExistsComponentTemplate Action](#clusterexistscomponenttemplate-action)
+      * [Cluster.Health Action](#clusterhealth-action)
+      * [Cluster.PostVotingConfigExclusions Action](#clusterpostvotingconfigexclusions-action)
+      * [Features Namespace](#features-namespace)
+      * [Indices.DeleteTemplateV2 Action](#indicesdeletetemplatev2-action)
+      * [Indices.ExistsTemplate Action](#indicesexiststemplate-action)
+      * [Indices.GetTemplateV2 Action](#indicesgettemplatev2-action)
+      * [Indices.PutTemplateV2 Action](#indicesputtemplatev2-action)
+      * [Nodes.HotThreads Action](#nodeshotthreads-action)
+      * [Nodes.Stats Action](#nodesstats-action)
+      * [Snapshot.CleanupRepository Action](#snapshotcleanuprepository-action)
+      * [Tasks.List Action](#taskslist-action)
+    * [OpenSearch.Client](#opensearchclient)
+      * [General](#general-1)
+      * [Cat.Indices Action](#catindices-action-1)
+      * [Cat.Master Action](#catmaster-action-1)
+      * [Cat.Plugins Action](#catplugins-action-1)
+      * [Cluster.GetComponentTemplate Action](#clustergetcomponenttemplate-action)
+      * [Cluster.Health Action](#clusterhealth-action-1)
+      * [Cluster.PostVotingConfigExclusions Action](#clusterpostvotingconfigexclusions-action-1)
+      * [Cluster.Stats Action](#clusterstats-action)
+      * [Indices.GetComposableTemplate Action](#indicesgetcomposabletemplate-action)
+      * [Nodes.HotThreads Action](#nodeshotthreads-action-1)
+      * [Nodes.Stats Action](#nodesstats-action-1)
+      * [Tasks.List Action](#taskslist-action-1)
+<!-- TOC -->
+
+# Upgrading OpenSearch.Net & OpenSearch.Client
 
+## 1.x.y to 2.0.0
 
 ### OpenSearch.Net
+
 #### General
 - Support for .NET Framework v4.6.1 has been removed, if you have a .NET Framework based project it is recommended to upgrade the project to target .NET Framework v4.7.2 or higher.
 - The `MasterTimeSpanout` & `ClusterManagerTimeSpanout` parameters on all actions have been corrected to `MasterTimeout` and `ClusterManagerTimeout` respectively.
@@ -60,8 +97,8 @@
 #### Tasks.List Action
 - The `GroupBy` parameter's `GroupBy` enum has been renamed to `TasksGroupBy`.
 
-
 ### OpenSearch.Client
+
 #### General
 - The `MasterTimeout` parameters on all actions have been marked `[Obsolete]`, please migrate to using `ClusterManagerTimeout` if your OpenSearch cluster is at least version `2.0.0` as `MasterTimeout` may be removed in future major versions.
 - The `ExpandWildcards` enum is now attributed with `[Flags]` to allow combining of multiple values e.g. `ExpandWildcards.Open | ExpandWildcards.Closed` to match open and closed indexes but not hidden.