Skip to content

Automatic update for Istio versions in Docs #1374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
istio-testing merged 1 commit into from
Nov 24, 2025
Merged

Automatic update for Istio versions in Docs #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/addons/addons.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
10 changes: 5 additions & 5 deletions docs/addons/observability.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
10 changes: 5 additions & 5 deletions docs/common/create-and-configure-gateways.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/common/istio-ambient-mode.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/common/istio-ambient-waypoint.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/deployment-models/consolidating-cp.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/deployment-models/multicluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/deployment-models/multiple-mesh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/dual-stack/dual-stack.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/general/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/general/istiod-ha.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
12 changes: 6 additions & 6 deletions docs/general/plugin-ca.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
24 changes: 12 additions & 12 deletions docs/guidelines/guidelines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down Expand Up @@ -97,12 +97,12 @@ Use code blocks for commands or groups of commands that have the same context. *
All AsciiDoc files should include variable definitions at the top for GitHub compatibility:
```
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3
```

Note: that the values of the variables will be automatically updated on each release to keep them in sync with the actual versions.
Expand Down
12 changes: 6 additions & 6 deletions docs/update-strategy/update-strategy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Variables embedded for GitHub compatibility
:istio_latest_version: 1.26.3
:istio_latest_version_revision_format: 1-26-3
:istio_latest_tag: v1.26-latest
:istio_release_name: release-1.26
:istio_latest_minus_one_version: 1.26.2
:istio_latest_minus_one_version_revision_format: 1-26-2
:istio_latest_version: 1.28.0
:istio_latest_version_revision_format: 1-28-0
:istio_latest_tag: v1.28-latest
:istio_release_name: release-1.28
:istio_latest_minus_one_version: 1.27.3
:istio_latest_minus_one_version_revision_format: 1-27-3

link:../../README.adoc[Return to Project Root]

Expand Down
69 changes: 69 additions & 0 deletions hack/update-istio-in-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
#!/bin/bash

# Copyright Istio Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -euo pipefail

YAML_FILE="pkg/istioversion/versions.yaml"

SED_CMD="sed"
if [[ "$(uname)" == "Darwin" ]]; then
SED_CMD="gsed"
fi

# Check if yq is installed
if ! command -v yq &> /dev/null
then
echo "Error: 'yq' command not found." >&2
echo "Please install yq (e.g., 'brew install yq' or 'sudo snap install yq')." >&2
exit 1
fi

echo "Extracting the latest two 'version' values from $YAML_FILE..."

LATEST_VERSIONS=$(yq '.versions[] | select(.version) | .version' "$YAML_FILE" | head -n 2)
if [ -z "$LATEST_VERSIONS" ]; then
echo "No versions with a 'version' property found."
exit 1
fi

echo "$LATEST_VERSIONS"

# Check all the ascii docs in docs/ and update the istio version variables
# LATEST_VERSIONS[0] is latest and LATEST_VERSIONS[1] is latest minus one
LATEST_VERSION=$(echo "$LATEST_VERSIONS" | sed -n '1p')
LATEST_VERSION_REVISION_FORMAT=$(echo "$LATEST_VERSION" | tr '.' '-')
LATEST_TAG="v${LATEST_VERSION%.*}-latest"
LATEST_RELEASE_NAME="release-${LATEST_VERSION%.*}"
LATEST_MINUS_ONE_VERSION=$(echo "$LATEST_VERSIONS" | sed -n '2p')
LATEST_MINUS_ONE_VERSION_REVISION_FORMAT=$(echo "$LATEST_MINUS_ONE_VERSION" | tr '.' '-')
echo "The versions to update are:"
echo "LATEST_VERSION: $LATEST_VERSION"
echo "LATEST_VERSION_REVISION_FORMAT: $LATEST_VERSION_REVISION_FORMAT"
echo "LATEST_TAG: $LATEST_TAG"
echo "LATEST_RELEASE_NAME: $LATEST_RELEASE_NAME"
echo "LATEST_MINUS_ONE_VERSION: $LATEST_MINUS_ONE_VERSION"
echo "LATEST_MINUS_ONE_VERSION_REVISION_FORMAT: $LATEST_MINUS_ONE_VERSION_REVISION_FORMAT"

for file in docs/**/*.adoc; do
echo "Updating file: $file"
"$SED_CMD" -i -E "s/(:istio_latest_version: ).*/\1$LATEST_VERSION/" "$file"
"$SED_CMD" -i -E "s/(:istio_latest_version_revision_format: ).*/\1$LATEST_VERSION_REVISION_FORMAT/" "$file"
"$SED_CMD" -i -E "s/(:istio_latest_tag: ).*/\1$LATEST_TAG/" "$file"
"$SED_CMD" -i -E "s/(:istio_release_name: ).*/\1$LATEST_RELEASE_NAME/" "$file"
"$SED_CMD" -i -E "s/(:istio_latest_minus_one_version: ).*/\1$LATEST_MINUS_ONE_VERSION/" "$file"
"$SED_CMD" -i -E "s/(:istio_latest_minus_one_version_revision_format: ).*/\1$LATEST_MINUS_ONE_VERSION_REVISION_FORMAT/" "$file"
done
echo "Documentation files updated successfully."
2 changes: 2 additions & 0 deletions tools/update_deps.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ else
echo "No latest version found for kindest/node on Docker Hub. Keeping the existing KIND_IMAGE."
fi

# Update Istio versions in the Documentation files
./hack/update-istio-in-docs.sh

# Regenerate files
make update-istio gen
Loading