Merge pull request #396 from zowe/feature/Automate_changelog_note

 Automate changelog note

.github/workflows/build-configmgr.yml

@@ -25,6 +25,90 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
+  update-changelog:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    outputs:
+      was_updated: ${{ steps.check-change.outputs.change_detected }}
+      check_commit: ${{ steps.check-changelog.outputs.check_commit }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Check for updated CHANGELOG.md using git
+        id: check-changelog
+        run: |
+          if git diff --name-only origin/${{ github.base_ref }} | grep -q "^CHANGELOG.md$"; then
+            echo "CHANGELOG.md has been updated."
+            echo "::set-output name=check_commit::true"
+          else
+            echo "ERROR: CHANGELOG.md has not been updated."
+            echo "::set-output name=check_commit::false"
+          fi
+      - name: Compare PR description with template
+        if: steps.check-changelog.outputs.check_commit == 'false'
+        env:
+          PR_DESCRIPTION: ${{ github.event.pull_request.body }}
+        run: |
+          # 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: |
+          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:X.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: |
+          if git diff --name-only HEAD^ HEAD | grep 'changelog.md'; then
+            echo "No Changes detected, setting flag to false"
+            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
+
   build-test:
     runs-on: ubuntu-latest
     needs: check-permission

.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).trim();
+    } else if (line.startsWith('VERSION:')) {
+      version = line.substring('VERSION:'.length).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('# Zowe Common C Changelog')) {
+        anchorIndex = i;
+      } else if (changelogLines[i].startsWith('## ' + version)) {  // Removed "v" prefix
+        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

@@ -5,6 +5,7 @@
 - WTO printing methods have been moved to zos.c to be more available as utilities (for ex: for the Launcher)
 
 ## `2.10.0`
+- This action making a CHANGELOG note via special syntax from the GitHub PR commit message, like it could automatically update CHANGELOG.md with the message. First job checks if PR body has changelog note or not if it's not there then it asked them to add it and second job is to check if changelog note has been added in changelog.md file or not. (#396)
 
 - Feature: The configmgr can now use the 'zos' module in YAML config templates. The 'zos' module is only added when run on ZOS. For a list of available functions, see https://github.com/zowe/zowe-install-packaging/blob/v2.x/staging/build/zwe/types/%40qjstypes/zos.d.ts (#384)
 - Bugfix: configmgr parsing of yaml to json was limited to 256 characters for strings. This has been updated to 1024 to allow for up to max unix path strings. (#383)