Add comments to GitHub action workflows that explain maining of git diff

Author: Test User

.github/workflows/commit_to_main.yml

@@ -28,10 +28,10 @@ jobs:
 
       - name: Install dependencies
         run: |
-            sudo apt-get update
-            sudo apt-get -y install libxml2-utils
-            python -m pip install --upgrade pip
-            python -m pip install PyYaml
+          sudo apt-get update
+          sudo apt-get -y install libxml2-utils
+          python -m pip install --upgrade pip
+          python -m pip install PyYaml
 
       - name: Render xml to markdown
         run: |
@@ -53,5 +53,4 @@ jobs:
         run: |
           git push
         env:
-          # This uses the default GITHUB_TOKEN with write permissions
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pull_request_ci.yml

@@ -20,8 +20,8 @@ jobs:
 
       - name: Install dependencies
         run: |
-            sudo apt-get update
-            sudo apt-get -y install libxml2-utils
+          sudo apt-get update
+          sudo apt-get -y install libxml2-utils
 
       - name: Check for duplicate standard names
         run: |
@@ -63,19 +63,21 @@ jobs:
 
       - name: Install dependencies
         run: |
-            sudo apt-get update
-            sudo apt-get -y install libxml2-utils
-            python -m pip install --upgrade pip
-            python -m pip install PyYaml
+          sudo apt-get update
+          sudo apt-get -y install libxml2-utils
+          python -m pip install --upgrade pip
+          python -m pip install PyYaml
 
       - name: Test rendering xml file to markdown
         run: |
           tools/write_standard_name_table.py --output-format md standard_names.xml
-          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.md):"
+          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.md; "
+          echo "assuming that 'Metadata-standard-names.md' wasn't updated and matches the version in the authoritative branch):"
           git diff Metadata-standard-names.md
 
       - name: Test rendering xml file to yaml
         run: |
           tools/write_standard_name_table.py --output-format yaml standard_names.xml
-          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.yaml):"
+          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.yaml; "
+          echo "assuming that 'Metadata-standard-names.yaml' wasn't updated and matches the version in the authoritative branch):"
           git diff Metadata-standard-names.yaml