Misc release script improvements (#692)

* Write a script to update the documentation versions file
* Update GitLab CI scripts to avoid deployments for dev and alpha tags
* Remove temporary link check exceptions

Closes #680

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Will Killian (https://github.com/willkill07)

URL: #692

Author: dagardner-nv

ci/markdown-link-check-config.json

@@ -14,12 +14,6 @@
         },
         {
             "pattern": "^https://www\\.mysql\\.com"
-        },
-        {
-            "pattern": "^https://docs\\.nvidia\\.com/nemo/agent-toolkit"
-        },
-        {
-            "pattern": "^https://media\\.githubusercontent\\.com/media/NVIDIA/NeMo-Agent-Toolkit/refs/heads/main/docs/source/_static/banner\\.png"
         }
     ]
 }

ci/release/update-version.sh

@@ -90,3 +90,8 @@ for TOML_FILE in "${NAT_PACKAGE_TOMLS[@]}"; do
       --new-version="${NAT_VERSION}" \
       --version-match="${VERSION_MATCH}"
 done
+
+# Update the documentation versions1.json file
+${CUR_DIR}/update_doc_versions1.py \
+  --versions-file=${PROJECT_ROOT}/docs/source/versions1.json \
+  --new-version="${NEXT_SHORT_TAG}"

ci/release/update_doc_versions1.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+import json
+
+import click
+
+
+@click.command()
+@click.option("--versions-file", required=True, type=click.Path(exists=True), help="Path to the versions file.")
+@click.option("--new-version", required=True, help="New version to set for the package.")
+def main(versions_file: str, new_version: str):
+    if new_version.count('.') != 1:
+        raise ValueError("Version string must only include <major>.<minor>")
+
+    with open(versions_file, "r", encoding="utf-8") as fh:
+        version_list = json.load(fh)
+
+    for version_data in version_list:
+        version_data.pop('preferred', None)
+        if version_data['version'] == new_version:
+            raise ValueError(f"Version {new_version} already exists in the versions file.")
+
+    version_list.insert(0, {"version": new_version, "preferred": True, "url": f"../{new_version}/"})
+
+    with open(versions_file, "w", encoding="utf-8") as fh:
+        json.dump(version_list, fh, indent=4)
+        fh.write("\n")  # Add a trailing newline
+
+
+if __name__ == "__main__":
+    main()

ci/scripts/gitlab/artifactory_upload.sh

@@ -22,7 +22,7 @@ GITLAB_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd
 source ${GITLAB_SCRIPT_DIR}/common.sh
 
 GIT_TAG=$(get_git_tag)
-IS_TAGGED=$(is_current_commit_tagged)
+IS_TAGGED=$(is_current_commit_release_tagged)
 rapids-logger "Git Version: ${GIT_TAG} - Is Tagged: ${IS_TAGGED}"
 
 # change this to ready to publish. this should be done programmatically once

ci/scripts/gitlab/build_wheel.sh

@@ -21,7 +21,7 @@ GITLAB_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd
 source ${GITLAB_SCRIPT_DIR}/common.sh
 
 GIT_TAG=$(get_git_tag)
-IS_TAGGED=$(is_current_commit_tagged)
+IS_TAGGED=$(is_current_commit_release_tagged)
 rapids-logger "Git Version: ${GIT_TAG} - Is Tagged: ${IS_TAGGED}"
 
 if [[ "${CI_CRON_NIGHTLY}" == "1" || ( ${IS_TAGGED} == "1" && "${CI_COMMIT_BRANCH}" != "main" ) ]]; then

ci/scripts/gitlab/common.sh

@@ -34,25 +34,33 @@ function get_git_tag() {
             exit 1;
         fi
 
-        # If the branch is a nightly build create a version which will be accepted by pypi
-        # Note: We are intentionally creating an actual tag, just setting the variable
-        GIT_TAG=$(echo $GIT_TAG | sed -e "s|-.*|a$(date +"%Y%m%d")|")
+        # If the branch is a nightly build create a version which will be accepted by pypi,
+        # The sed script here is splitting on either the first dash or 'a',
+        # transforming a tag like `v1.3.0-dev-17-g7681cf9f` into `v1.3.0a20250821`
+        # and a tag like `v1.3.0a5` into `v1.3.0a20250821`
+        # Note: We are intentionally not ceating an actual tag, just setting the variable
+        GIT_TAG=$(echo $GIT_TAG | sed -E -e "s/(-|a).*/a$(date +"%Y%m%d")/")
     fi
 
     echo ${GIT_TAG}
 }
 
-function is_current_commit_tagged() {
-    # Check if the current commit is tagged
+function is_current_commit_release_tagged() {
+    # Check if the current commit is tagged for release, either an RC tag or the release tag
     set +e
-    git describe --tags --exact-match HEAD >/dev/null 2>&1
+    GIT_TAG=$(git describe --tags --exact-match HEAD 2>/dev/null)
     local status_code=$?
     set -e
 
     # Convert the unix status code to a boolean value
     local is_tagged=0
     if [[ ${status_code} -eq 0 ]]; then
-        is_tagged=1
+        local is_pre_release=0
+
+        # Ensure we don't have a dev or alpha tag
+        if [[ ! (${GIT_TAG} =~ "-dev" || ${GIT_TAG} =~ "a") ]]; then
+            is_tagged=1
+        fi
     fi
     echo ${is_tagged}
 }

docs/source/conf.py

@@ -138,7 +138,6 @@
     r'https://code.visualstudio.com',
     r'https://www.mysql.com',
     r'https://api.service.com',
-    r'https://media.githubusercontent.com/media/NVIDIA/NeMo-Agent-Toolkit/refs/heads/main/docs/source/_static/banner.png',  # noqa: E501
     r'http://custom-server'
 ]
 

docs/source/versions1.json

@@ -1,6 +1,10 @@
 [
     {
+        "version": "1.3",
         "preferred": true,
+        "url": "../1.3/"
+    },
+    {
         "version": "1.2",
         "url": "../1.2/"
     },

docs/source/workflows/evaluate.md

@@ -129,9 +129,10 @@ Evaluation is dependent on the judge LLM's ability to accurately evaluate the ge
     3)- meta/llama-3.1-70b-instruct
     4)- meta/llama-3.3-70b-instruct
 ```
-For a complete list of up-to-date judge LLMs, refer to the [RAGAS NV metrics leadership board](https://github.com/explodinggradients/ragas/blob/main/ragas/src/ragas/metrics/_nv_metrics.py)
+<!-- Update the link here when ragas is updated -->
+For a complete list of up-to-date judge LLMs, refer to the [RAGAS NV metrics leadership board](https://github.com/explodinggradients/ragas/blob/v0.2.14/src/ragas/metrics/_nv_metrics.py)
 
-For more information on the prompt used by the judge LLM, refer to the [RAGAS NV metrics](https://github.com/explodinggradients/ragas/blob/main/ragas/src/ragas/metrics/_nv_metrics.py). The prompt for these metrics is not configurable. If you need a custom prompt, you can use the [Tunable RAG Evaluator](../reference/evaluate.md#tunable-rag-evaluator) or implement your own evaluator using the [Custom Evaluator](../extend/custom-evaluator.md) documentation.
+For more information on the prompt used by the judge LLM, refer to the [RAGAS NV metrics](https://github.com/explodinggradients/ragas/blob/v0.2.14/src/ragas/metrics/_nv_metrics.py). The prompt for these metrics is not configurable. If you need a custom prompt, you can use the [Tunable RAG Evaluator](../reference/evaluate.md#tunable-rag-evaluator) or implement your own evaluator using the [Custom Evaluator](../extend/custom-evaluator.md) documentation.
 
 ### Trajectory Evaluator
 This evaluator uses the intermediate steps generated by the workflow to evaluate the workflow trajectory. The evaluator configuration includes the evaluator type and any additional parameters required by the evaluator.

examples/HITL/por_to_jiratickets/pyproject.toml

@@ -8,7 +8,7 @@ root = "../../.."
 [project]
 name = "nat_por_to_jiratickets"
 dynamic = ["version"]
-dependencies = ["nvidia-nat[langchain]~=1.2"]
+dependencies = ["nvidia-nat[langchain]~=1.3"]
 requires-python = ">=3.11,<3.13"
 description = "Custom NeMo Agent toolkit Workflow"
 classifiers = ["Programming Language :: Python"]