release-all: Update the docs with the nnf-deploy release (#280)

A release of the docs should have a reference to the matching nnf-deploy
release, so the two are kept in sync.

Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>

Author: roehrich-hpe

tools/release-all/final-release-notes.sh

@@ -34,7 +34,6 @@ do_fail() {
 
 WORKSPACE="workingspace"
 TARGET_NNF_RELEASE=
-SKIP_DOCS=
 DO_COMMIT=
 
 usage() {
@@ -43,9 +42,6 @@ usage() {
     echo
     echo "  -C                Commit the new release notes. First, run without"
     echo "                    this so you can review the notes."
-    echo "  -D                Skip the docs repo. If the docs repo did not have"
-    echo "                    updates for this NNF release, then specify this"
-    echo "                    option to skip it."
     echo "  -r nnf_release    Latest NNF release tag, including the leading 'v'."
     echo "                    This must refer to a completed NNF release,"
     echo "                    including the docs repo, and it must be the most"
@@ -55,14 +51,11 @@ usage() {
     echo
 }
 
-while getopts "CDr:w:h" opt; do
+while getopts "Cr:w:h" opt; do
     case $opt in
     C)
         DO_COMMIT=yes
         ;;
-    D)
-        SKIP_DOCS=yes
-        ;;
     r)
         TARGET_NNF_RELEASE="$OPTARG"
         ;;
@@ -389,12 +382,10 @@ dep_url="$NNF_DEPLOY_URL"
 dep_name=$(get_repo_dir_name "$dep_url")
 check_release_vX "$dep_repo_short_name" "$dep_name" "$dep_url" "releases/v0"
 
-if [[ -z $SKIP_DOCS ]]; then
-    doc_repo_short_name="nnf_doc"
-    doc_url="$NNF_DOC_URL"
-    doc_name=$(get_repo_dir_name "$doc_url")
-    check_release_vX "$doc_repo_short_name" "$doc_name" "$doc_url" "releases/v0"
-fi
+doc_repo_short_name="nnf_doc"
+doc_url="$NNF_DOC_URL"
+doc_name=$(get_repo_dir_name "$doc_url")
+check_release_vX "$doc_repo_short_name" "$doc_name" "$doc_url" "releases/v0"
 
 if [[ -n $NNF_DEPLOY_RELEASE && -f $RELEASE_PAGE ]]; then
     if [[ -n $DO_COMMIT ]]; then

tools/release-all/release-all.sh

@@ -578,6 +578,23 @@ update_nnf_mfu_release_references() {
     fi
 }
 
+# Update nnf-docs for the latest nnf-deploy release version.
+update_nnf_release_reference() {
+    local indent="$1"
+    local yml="mkdocs.yml"
+
+    [[ ! -f $yml ]] && return
+    nnf_deploy_release=$(find_latest_release nnf_deploy "$indent")
+    if [[ -z $nnf_deploy_release ]]; then
+        do_fail "${indent}Unable to get nnf-deploy releases"
+    fi
+    msg "${indent}Current latest nnf-deploy release is $nnf_deploy_release"
+    sed -i.bak -e 's/^# Release: .*/# Release: '"$nnf_deploy_release"'/' $yml || do_fail "${indent}Failed to replace nnf-deploy release reference"
+    rm -f $yml.bak
+    git add $yml
+    git commit -s -m "Update nnf-deploy release reference" || do_fail "${indent}Failure updating nnf-deploy release reference"
+}
+
 # Update lustre-fs-operator, lustre-csi-driver for
 # nnf-deploy's config/repositories.yaml.
 update_remote_release_references() {
@@ -760,6 +777,10 @@ check_repo_release_vX() {
         fi
         verify_clean_workarea "$indent"
         make || do_fail "${indent}Failure building the nnf-deploy binary."
+
+    elif [[ $repo_short_name == nnf_doc ]]; then
+        update_nnf_release_reference "$indent"
+        verify_clean_workarea "$indent"
     fi
 
     if [[ $(git log --oneline "$branch...HEAD" | wc -l) -gt 0 ]]; then