Merge pull request #69531 from aireilly/update-rn-checker

Update link checker

Author: aireilly

scripts/check-rn-link-perms.sh

@@ -1,67 +1,30 @@
 #!/bin/bash
-# Checks if a release notes file is updated. If true, searches the release notes file for links to bugs that are behind a login and fails the build.
-# We should not include internal bugs in our release notes.
+# Report errors for links to Red Hat JIRA bugs that are behind a login
 
-# Get the repo path and files changed
-REPO_PATH="$(git rev-parse --show-toplevel)"
-FILES=$(git diff --name-only HEAD~1 HEAD --diff-filter=d "*release-notes*.adoc" ':(exclude)_unused_topics/*')
+# Get modifed lines, remove deleted lines from the diff 
+git_diff=$(git diff --unified=0 --stat --diff-filter=AM HEAD~1 HEAD "*release-notes*.adoc" ':(exclude)_unused_topics/*' | grep '^+' | grep -Ev '^(\+\+\+ a/ b/)')
 
-# Function to check links in updated release notes
-check_rn_links () {
-
-    # Iterate through RN files because could potentially be more than one (e.g. OCP + ROSA)
-    for RELEASE_FILE in ${FILES}; do
-        echo ""
-        echo "#########"
-        echo "You updated the following release notes file:"
-        echo "$RELEASE_FILE"
-        echo "#########"
-        echo ""
-
-        # Read the content from the local release note file
-        content=$(cat "$REPO_PATH/$RELEASE_FILE")
-
-        # Exclude content within //// multi-line comments
-        content=$(echo "${content}" | sed ':a;N;$!ba;s#////\n.*////##g')
-
-        # Extract links from the content, excluding single-line comments
-        links=$(echo "$content" | grep -v '^//.*' | grep -o 'https://issues[^]]*' | sed 's/\[.*//')
-        protected_links=()
-
-        echo ""
-        echo "#########"
-        echo "Checking for internal bug links in $REPO_PATH/$RELEASE_FILE"
-        echo "#########"
-        echo ""
-
-        # Iterate over the links and check their authorization status
-        for link in $links
-        do
-            response=$(curl -I "$link" 2>&1)
+# Exit zero if there are no release-notes changes 
+if [ -z "${git_diff}" ]; then
+    exit 0
+fi
 
-            if echo "$response" | grep -q "permissionViolation"; then
-                echo "The link $link points to an internal bug."
-                protected_links+=("$link")         
-            fi
-        done
+# Remove all multi-line comments and single line comments
+git_diff=$(echo "${git_diff}" | sed '\|^+////|,\|^+////|c\\' | sed '\|^+//| s|.*|//|')
 
-    done
+# Search the git diff for links
+link_regex='https://issues\.redhat\.com/browse/[A-Z]+-[0-9]+'
+links=$(echo "${git_diff}" | grep -o -E "$link_regex" | sort -u)
 
-    # Print the list of links that require authentication
-        if [ ${#protected_links[@]} -eq 0 ]; then
-            echo "No links require authentication, exiting."
-            exit 0
-        else
-            echo "Links that require authentication:"
-            printf '%s\n' "${protected_links[@]}"
-            echo "Build failed. Ensure there are no links to internal JIRA bugs, which have a security level of Red Hat Employee only."
-            exit 1
-        fi
-}
+for link in ${links}; do
+    # Check for links that require a login
+    response=$(curl -I "${link}" 2>&1)
+    if echo "${response}" | grep -q "permissionViolation"; then
+        errors=true
+        echo -e "\e[31mERROR: Do not include links to JIRA issues that require a login (${link})\n"
+    fi
+done
 
-if [[ $FILES == *"release-notes"* ]]; then
-    check_rn_links
-else
-    echo "No release notes updated, exiting."
-    exit 0
+if [ "$errors" = true ]; then
+    exit 1
 fi