API-44751 Testing environment contents

.github/workflows/send-to-lpb.yaml

@@ -1,4 +1,20 @@
 name: Post content to Lighthouse Platform Backend (LPB)
+
+# This GitHub Actions workflow is designed to facilitate the seeding of release
+# notes to the Lighthouse Platform Backend (LPB). The process is triggered
+# manually and allows you to specify the environment (development or production)
+# in which the seeding should occur. The workflow is separated into three main
+# jobs:
+#   * gathering content,
+#   * sending content to the development environment, and
+#   * sending content to the production environment.
+#
+# NOTE: deleted files are processed before changed files
+#       because non-technicals are using the Github UI to
+#       add, change, rename and delete files.  It is possible
+#       that they could delete an existing release note and
+#       add a new release note with the same name or date.
+
 on:
   pull_request:
     types:
@@ -9,6 +25,7 @@ on:
     branches: [main]
 
 jobs:
+
   gather_content:
     name: Gather the changed content
     runs-on: ubuntu-latest
@@ -25,37 +42,67 @@ jobs:
           fi
           echo $TARGET_ENVIRONMENT
           echo "target_environment=$TARGET_ENVIRONMENT" >> $GITHUB_OUTPUT
+
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
+      ##############################
+      ## Global git diff -raw main...
+
+      - name: Checkout Main Branch
+        run: git checkout main
+
+      - name: Get Feature Branch Name
+        id: get-feature-branch
+        run: |
+          echo "FEATURE_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+
+      - name: Check out Feature Branch
+        run: git checkout ${{ steps.get-feature-branch.outputs.FEATURE_BRANCH }}
+
+      - name: Get Raw Diff and Write to File
+        run: |
+          DIFF=$(git diff --raw main...${{ steps.get-feature-branch.outputs.FEATURE_BRANCH }})
+          echo "$DIFF" > raw_diff.txt
+
+      - name: Output Diff (Example - Read from File)
+        run: |
+          echo "Raw Diff (from file):"
+          cat raw_diff.txt
+
       - id: pr_files
-        uses: Ana06/[email protected]
+        run: |
+          chmod +x bin/actions/changed_files.sh
+          sh bin/actions/changed_files.sh
+
       - id: upload_content
         name: Find files and send them
         continue-on-error: true
         run: |
-          # If it's a PR change from a space delimited list to one file per line
-          if [ "${{ steps.pr_files.outputs.added_modified_renamed }}" != "" ]; then
-            touch changed-files.txt
-            for f in `echo "${{ steps.pr_files.outputs.added_modified_renamed }}"`; do
-              echo $f >> changed-files.txt
-            done
-          fi
-          if [ "${{ steps.pr_files.outputs.renamed }}" != "" ]; then
-            echo "rename_warning=TRUE" >> $GITHUB_OUTPUT
-          fi
-          echo "Expected files changes:"
+          echo "Changed files:"
           cat changed-files.txt
+          #
+          echo "Deleted files:"
+          cat deleted-files.txt
+
       - name: Save changed files list
         uses: actions/upload-artifact@v4
         with:
           name: changed-files
           path: changed-files.txt
+
+      - name: Save deleted files list
+        uses: actions/upload-artifact@v4
+        with:
+          name: deleted-files
+          path: deleted-files.txt
+
   send_content_to_development:
     name: Send content to development LPB
     needs: [gather_content]
-    environment: 
+    environment:
       name: development
       url: https://dev-developer.va.gov
     runs-on: ubuntu-latest
@@ -65,8 +112,10 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
       - name: NPM install
         run: npm ci
+
       - id: get_bearer_token
         if: github.actor != 'dependabot[bot]'
         name: Get Bearer Token
@@ -75,36 +124,76 @@ jobs:
           LPB_CLIENT_ID: ${{ secrets.LPB_CLIENT_ID }}
           LPB_RSA_TOKEN: ${{ secrets.LPB_RSA_SECRET }}
           OKTA_TOKEN_AUD: 'https://deptva-eval.okta.com/oauth2/ausg95zxf6dFPccy02p7/v1/token'
-        run:
+        run: |
           echo "$LPB_RSA_TOKEN" > ./rsa.pem;
           ls -la;
           wc -l ./rsa.pem;
           node ./get-bearer-token.js $LPB_CLIENT_ID ./rsa.pem $LPB_HOST $OKTA_TOKEN_AUD;
           BEARER_TOKEN=`cat ./bearer.token`;
           echo "bearer_token=$BEARER_TOKEN" >> $GITHUB_ENV;
-      - name: Get file list
+
+      #############################
+      ##       Development       ##
+      ## Processed Deleted Files ##
+      #############################
+
+      - name: Get deleted files list
+        uses: actions/download-artifact@v4
+        if: github.actor != 'dependabot[bot]'
+        with:
+          name: deleted-files
+
+      - name: Send deleted files to development
+        if: github.actor != 'dependabot[bot]'
+        env:
+          LPB_HOST: 'dev-api.va.gov'
+        run: |
+          # SAFE WAY TO ITERATE LINES - Handles spaces in filenames
+          while IFS= read -r n; do
+            echo "DEV: Deleting $n from LPB";
+            DATE_STRING=$(basename -- "$n" | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}')
+            TARGET_API=$(echo "$n" | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/');
+            echo "Target URL https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+            curl --request DELETE \
+                 --header 'Content-Type:application/json' \
+                 --header "Authorization:Bearer ${{ env.bearer_token }}" \
+                 --data "{\"date\":\"$DATE_STRING\"}" \
+                 "https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+          done < deleted-files.txt
+
+      #############################
+      ##       Development       ##
+      ## Processed Changed Files ##
+      #############################
+
+      - name: Get changed files list
         uses: actions/download-artifact@v4
         if: github.actor != 'dependabot[bot]'
         with:
           name: changed-files
-      - name: Send content to development
+
+      - name: Send changed content to development
         if: github.actor != 'dependabot[bot]'
         env:
           LPB_HOST: 'dev-api.va.gov'
-        run:
-          for n in `cat changed-files.txt | grep content/`; do
+        run: |
+          # SAFE WAY TO ITERATE LINES - Handles spaces in filenames
+          while IFS= read -r n; do
+            # ignore the file if it does not exist or is not readable
+            [ -r "$n" ] || continue
+
             echo "Posting $n to LPB";
-            DATE_STRING=`echo $n | sed 's/[\/\.a-z\-]//g' | sed -E 's/([0-9]{4})([0-9]{2})([0-9]{2})/\1-\2-\3/'`;
-            CONTENT_STRING=`cat $n | base64 -w 0`;
-            TARGET_API=`echo $n | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/'`;
+            DATE_STRING=$(basename -- "$n" | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}')
+            CONTENT_STRING=$(cat "$n" | base64 -w 0);
+            TARGET_API=$(echo "$n" | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/');
             echo "Target URL https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
-            curl
-              --request POST
-              --header 'Content-Type:application/json'
-              --header "Authorization:Bearer ${{ env.bearer_token }}"
-              --data "{\"date\":\"$DATE_STRING\",\"content\":\"base64:$CONTENT_STRING\"}"
-              https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes;
-          done;
+            curl --request POST \
+                 --header 'Content-Type:application/json' \
+                 --header "Authorization:Bearer ${{ env.bearer_token }}" \
+                 --data "{\"date\":\"$DATE_STRING\",\"content\":\"base64:$CONTENT_STRING\"}" \
+                 "https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+          done < changed-files.txt
+
       - name: Comment on PR
         uses: actions/github-script@v7
         if: github.actor != 'dependabot[bot]'
@@ -116,6 +205,7 @@ jobs:
               repo: context.repo.repo,
               body: 'These changes have been pushed to [dev](https://dev-developer.va.gov/).'
             })
+
       - name: Previously Merged Warning Comment on PR
         uses: actions/github-script@v7
         if: |
@@ -129,10 +219,11 @@ jobs:
               repo: context.repo.repo,
               body: 'If this release note was merged to the `main` branch on another PR, you will need to reach out to [Team Okapi](https://lighthouseva.slack.com/archives/C01931CFMTQ) to remove the copy that remains on the previous date.'
             })
+
   send_content_to_production:
     name: Send content to production LPB
     needs: [gather_content]
-    environment: 
+    environment:
       name: production
       url: https://developer.va.gov
     runs-on: ubuntu-latest
@@ -142,8 +233,10 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
       - name: NPM install
         run: npm ci
+
       - id: get_bearer_token
         if: github.actor != 'dependabot[bot]'
         name: Get Bearer Token
@@ -152,36 +245,78 @@ jobs:
           LPB_CLIENT_ID: ${{ secrets.LPB_CLIENT_ID }}
           LPB_RSA_TOKEN: ${{ secrets.LPB_RSA_SECRET }}
           OKTA_TOKEN_AUD: 'https://va.okta.com/oauth2/ausdppulkgBFJDZZe297/v1/token'
-        run:
+        run: |
           echo "$LPB_RSA_TOKEN" > ./rsa.pem;
           ls -la;
           wc -l ./rsa.pem;
           node ./get-bearer-token.js $LPB_CLIENT_ID ./rsa.pem $LPB_HOST $OKTA_TOKEN_AUD;
           BEARER_TOKEN=`cat ./bearer.token`;
           echo "bearer_token=$BEARER_TOKEN" >> $GITHUB_ENV;
-      - name: Get file list
+
+      #############################
+      ##       Production        ##
+      ## Processed Deleted Files ##
+      #############################
+
+      - name: Get deleted files list
+        uses: actions/download-artifact@v4
+        if: github.actor != 'dependabot[bot]'
+        with:
+          name: deleted-files
+
+      - name: Send deleted files to production
+        if: github.actor != 'dependabot[bot]'
+        env:
+          LPB_HOST: 'api.va.gov'
+        run: |
+          # SAFE WAY TO ITERATE LINES - Handles spaces in filenames
+          while IFS= read -r n; do
+            echo "PROD: Deleting $n from LPB";
+            DATE_STRING=$(basename -- "$n" | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}')
+            TARGET_API=$(echo "$n" | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/');
+            echo "Target URL https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+            curl --request DELETE \
+                 --header 'Content-Type:application/json' \
+                 --header "Authorization:Bearer ${{ env.bearer_token }}" \
+                 --data "{\"date\":\"$DATE_STRING\"}" \
+                 "https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+          done < deleted-files.txt
+
+
+      #############################
+      ##       Production        ##
+      ## Processed Changed Files ##
+      #############################
+
+      - name: Get changed files list
         uses: actions/download-artifact@v4
         if: github.actor != 'dependabot[bot]'
         with:
           name: changed-files
-      - name: Send content to production
+
+      - name: Send changed files to production
         env:
           LPB_HOST: 'api.va.gov'
         if: github.actor != 'dependabot[bot]'
-        run:
-          for n in `cat changed-files.txt | grep content/`; do
-            echo "Posting $n to LPB";
-            DATE_STRING=`echo $n | sed 's/[\/\.a-z\-]//g' | sed -E 's/([0-9]{4})([0-9]{2})([0-9]{2})/\1-\2-\3/'`;
-            CONTENT_STRING=`cat $n | base64 -w 0`;
-            TARGET_API=`echo $n | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/'`;
-            echo "Target URL https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
-            curl
-              --request POST
-              --header 'Content-Type:application/json'
-              --header "Authorization:Bearer ${{ env.bearer_token }}"
-              --data "{\"date\":\"$DATE_STRING\",\"content\":\"base64:$CONTENT_STRING\"}"
-              https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes;
-          done;
+        run: |
+          # SAFE WAY TO ITERATE LINES - Handles spaces in filenames
+          while IFS= read -r n; do
+            # ignore the file if it does not exist or is not readable
+            [ -r "$n" ] || continue
+            if [[ "$n" == *'content/'* ]]; then
+              echo "Posting $n to LPB";
+              DATE_STRING=$(basename -- "$n" | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}')
+              CONTENT_STRING=$(cat "$n" | base64 -w 0);
+              TARGET_API=$(echo "$n" | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/');
+              echo "Target URL https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+              curl --request POST \
+                  --header 'Content-Type:application/json' \
+                  --header "Authorization:Bearer ${{ env.bearer_token }}" \
+                  --data "{\"date\":\"$DATE_STRING\",\"content\":\"base64:$CONTENT_STRING\"}" \
+                  "https://$LPB_HOST/internal/platform-backend/v0/providers/$TARGET_API/release-notes";
+            fi
+          done < changed-files.txt
+
       - name: Comment on PR
         uses: actions/github-script@v7
         if: github.actor != 'dependabot[bot]'
@@ -193,6 +328,7 @@ jobs:
               repo: context.repo.repo,
               body: 'These changes have been pushed to [production](https://developer.va.gov/).'
             })
+
   send_notifications:
     name: Send Slack notification for newly published release notes
     needs: [gather_content, send_content_to_production]
@@ -223,12 +359,15 @@ jobs:
           wget -O legacy.json https://developer.va.gov/platform-backend/v0/providers/transformations/legacy.json?environment=sandbox
 
           # Loop over the list of changed release note files
-          for n in `cat changed-files.txt | grep content/ | grep release-notes`; do
-            TARGET_API=`echo $n | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/'`;
-            TARGET_API_NAME=`jq -r ".[].apis[] | select(.altID==\"$TARGET_API\" or .urlSlug==\"$TARGET_API\") | .name" legacy.json`;
-            TARGET_URL_SLUG=`jq -r ".[].apis[] | select(.altID==\"$TARGET_API\" or .urlSlug==\"$TARGET_API\") | .urlSlug" legacy.json`;
-            URLS+="[$TARGET_API_NAME release notes](https://developer.va.gov/explore/api/$TARGET_URL_SLUG/release-notes)\n";
-          done
+          # SAFE WAY TO ITERATE LINES - Handles spaces in filenames
+          while IFS= read -r n; do
+            if [[ "$n" == *'content/'* ]] && [[ "$n" == *'release-notes'* ]]; then
+              TARGET_API=$(echo "$n" | sed -E 's/.*\/([a-z\-]{1,})\/release-notes.*/\1/');
+              TARGET_API_NAME=$(jq -r ".[].apis[] | select(.altID==\"$TARGET_API\" or .urlSlug==\"$TARGET_API\") | .name" legacy.json);
+              TARGET_URL_SLUG=$(jq -r ".[].apis[] | select(.altID==\"$TARGET_API\" or .urlSlug==\"$TARGET_API\") | .urlSlug" legacy.json);
+              URLS+="[$TARGET_API_NAME release notes](https://developer.va.gov/explore/api/$TARGET_URL_SLUG/release-notes)\n";
+            fi
+          done < changed-files.txt
           echo "URLs: $URLS"
           echo "urls=${URLS}" >> $GITHUB_OUTPUT
       - name: Send Slack notification on success