reject PR if identical to pull_request_template.md

.github/workflows/build-core.yml

@@ -67,49 +67,40 @@ jobs:
             echo "ERROR: CHANGELOG.md has not been updated."
             echo "::set-output name=check_commit::false"
           fi
-      - name: Extract changelog info
+      - name: Compare PR description with template
         if: steps.check-changelog.outputs.check_commit == 'false'
-        id: extract-changelog
+        env:
+          PR_DESCRIPTION: ${{ github.event.pull_request.body }}
         run: |
-          PR_DESCRIPTION="${{ github.event.pull_request.body }}"
-          # Check if "changelog:" exists in PR description
-          if echo "$PR_DESCRIPTION" | grep -q "VERSION:" && echo "$PR_DESCRIPTION" | grep -q "CHANGELOG:"; then
-            # Extract text after "changelog:"
-            CHANGELOG_TEXT=$(echo $PR_DESCRIPTION | sed -n 's/.*CHANGELOG: \(.*\)/\1/p')
-            # Extract VERSION: from PR description
-            VERSION=$(echo "$PR_DESCRIPTION" | grep -oP 'VERSION:\s*\Kv\d+\.\d+\.\d+')
-            echo "Extracted changelog: $CHANGELOG_TEXT"
-            echo "::set-output name=changelog::$CHANGELOG_TEXT"
-            echo "::set-output name=version::$VERSION"
-          else
-            echo -e "No changelog and version information found in PR description please add them.\n Expected Format:\n VERSION:vX.XX.X\n CHANGELOG:This is changelog note.\n
-            To re-run the action, just make a push or commit after updating the PR description or updating the changelog via a manual file changing commit."
+          # Safely print the PR description using Node.js
+
+          node -e "const fs=require('fs'); fs.writeFileSync('/tmp/pr_description.txt', process.env.PR_DESCRIPTION);"
+          # Use diff to compare the two files
+          if diff -wB /tmp/pr_description.txt .github/pull_request_template.md > /dev/null; then
+            echo "ERROR: PR description is identical to the template."
             exit 1
+          else
+            echo "PR description and template are different."
           fi
+
       - name: Check PR body against changelog
         if: steps.check-changelog.outputs.check_commit == 'false'
+        id: extract-changelog
         run: |
-          ESCAPED_CHANGELOG="${{ steps.extract-changelog.outputs.changelog }}"
-          ESCAPED_CHANGELOG=$(echo "$ESCAPED_CHANGELOG" | sed "s/'/\\\\'/g")
-          VERSION="${{ steps.extract-changelog.outputs.version }}"
-
-          if ! grep -Fq "$ESCAPED_CHANGELOG" CHANGELOG.md; then
-            # Check if version exists in CHANGELOG.md
-            if grep -q "^## $VERSION" CHANGELOG.md; then
-              # Append PR description to existing version
-              sed -i "/^## $VERSION/a - $ESCAPED_CHANGELOG (#${{ github.event.pull_request.number }})" CHANGELOG.md
-            else
-              # Append new version and PR description
-              ANCHOR_LINE=$(awk '/All notable changes to the Zlux App Server package will be documented in this file\./ {print NR}' CHANGELOG.md)
-              sed -i "$ANCHOR_LINE a\\
-              \n## $VERSION\n- $ESCAPED_CHANGELOG (#${{ github.event.pull_request.number }})\n" CHANGELOG.md
-            fi
+          result=$(node .github/workflows/set-changelog.js ${{ github.event.pull_request.number }})
+          if [ "$result" = "Success" ]; then
             git config --global user.email "[email protected]"
             git config --global user.name "Zowe Robot"
             git add CHANGELOG.md
             git commit -s -m "Update changelog with PR #${{ github.event.pull_request.number }} description"
             git push
+            echo "Updated CHANGELOG from description"
+          else
+            echo $result
+            echo -e "No changelog and version information found in PR description. Please add them.\nExpected Format:\nVERSION:vX.XX.X\nCHANGELOG:This is changelog note.\nTo re-run the action, just make a push or commit after updating the PR description or updating the changelog via a manual file changing commit."
+            exit 1
           fi
+
       - name: check for changes
         id: check-change
         run: |
@@ -118,25 +109,23 @@ jobs:
             echo "::set-output name=change_detected::false"
           else
             echo "::set-output name=change_detected::true"
-          fi
-
-  check_changelog:
-      if: github.event_name == 'pull_request'
-      needs: update-changelog
-      runs-on: ubuntu-latest
-      steps:
-        - name: Checkout code
-          uses: actions/checkout@v2
-
-        - name: Verify Changelog update
-          run: |
-            if [ "${{ needs.update-changelog.outputs.was_updated }}" != "true" ]; then
-              echo "CHANGELOG.md not updated, please update CHANGELOG.md with the changes made in the pull request"
-              exit 1
-            else
-              echo "changelog was updated successfully."
             fi
+  check_changelog:
+    if: github.event_name == 'pull_request'
+    needs: update-changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
 
+      - name: Verify Changelog update
+        run: |
+          if [ "${{ needs.update-changelog.outputs.was_updated }}" != "true" ]; then
+            echo "CHANGELOG.md not updated, please update CHANGELOG.md with the changes made in the pull request"
+            exit 1
+          else
+            echo "changelog was updated successfully."
+          fi
   build:
     runs-on: ubuntu-latest
     needs: check-permission
@@ -152,7 +141,6 @@ jobs:
           key: ${{ runner.os }}-build-cache-node-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-build-cache-node-modules-
-
       - name: '[Prep 2] Setup Node'
         uses: actions/setup-node@v2
         with:
@@ -191,4 +179,3 @@ jobs:
 
       - name: '[Prep 7] deploy'
         uses: zowe-actions/zlux-builds/core/[email protected]/main
-

.github/workflows/set-changelog.js

@@ -0,0 +1,59 @@
+/*
+This program and the accompanying materials are
+made available under the terms of the Eclipse Public License v2.0 which accompanies
+this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html
+
+SPDX-License-Identifier: EPL-2.0
+
+Copyright Contributors to the Zowe Project.
+*/
+
+const fs=require('fs');
+
+//Must run with args: PR_NUMBER
+const PR_NUMBER = process.argv[2];
+
+const description = fs.readFileSync('/tmp/pr_description.txt', 'utf8');
+let changelogMsg, version; 
+
+if (description.includes('VERSION:') && description.includes('CHANGELOG:')) { 
+  let lines = description.split('\n'); 
+  lines.forEach((line)=> { 
+    if (line.startsWith('CHANGELOG:')) { 
+      changelogMsg = line.substring('CHANGELOG:'.length+1).trim(); 
+    } else if (line.startsWith('VERSION:')) { 
+      version = line.substring('VERSION:'.length+1).trim();
+    } 
+  }); 
+  if (changelogMsg && version) { 
+    let changelog = fs.readFileSync('CHANGELOG.md', 'utf8'); 
+    let changelogLines = changelog.split('\n');
+    let versionIndex = -1;
+    let anchorIndex = 0;
+    for (let i = 0; i < changelogLines.length; i++) {
+      if (changelogLines[i].includes('All notable changes to the Zlux App Server package will be documented in this file')) {
+        anchorIndex = i;
+      } else if (changelogLines[i].startsWith('## v'+version)) {
+        versionIndex = i;
+        break;
+      }
+    }
+    if (versionIndex != -1) {
+      changelogLines.splice(versionIndex+2, 0, `- ${changelogMsg} (#${PR_NUMBER})`);
+    } else {
+      changelogLines.splice(anchorIndex+1, 0, `\n## ${version}\n- ${changelogMsg} (#${PR_NUMBER})`);
+    }
+    const newChangelog = changelogLines.join('\n');
+    fs.writeFileSync('CHANGELOG.md', newChangelog);
+    console.log('Success');
+  } else {
+    if (!changelogMsg) {
+      console.log('Missing CHANGELOG');
+    }
+    if (!version) {
+      console.log('Missing VERSION');
+    }
+  }    
+} else {
+  console.log('Missing CHANGELOG or VERSION');
+}

CHANGELOG.md

@@ -3,10 +3,10 @@
 All notable changes to the Zlux App Server package will be documented in this file.
 
 ## v2.12.0
+
 - enhancement: new versions of components can change the location of their plugins, as the app-server will now re-inspect the plugin locations on each startup. (#280)
 - bugfix: Removed error message "components/app-server/bin/configure.sh 26: .: FSUM6807 expression syntax error" seen in startup of Zowe in v2.11.0, caused by incorrect shell syntax. (#283)
 
-
 ## v2.11.0
 
 - Bugfix: The server couldn't load more than one certificate authority specified within the zowe.certificate.pem.certificateAuthorities section under any condition. Now, it is supported regardless of if the section is an array or a comma-separated string. (#266)