From 541832013a74af62e1604452ce0433af1c2c1fc5 Mon Sep 17 00:00:00 2001 From: 1000TurquoisePogs Date: Fri, 13 Oct 2023 16:22:43 -0400 Subject: [PATCH] Move to node-base changelog setting Signed-off-by: 1000TurquoisePogs --- .github/workflows/build-core.yml | 69 +++++------------------------- .github/workflows/set-changelog.js | 59 +++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 58 deletions(-) create mode 100644 .github/workflows/set-changelog.js diff --git a/.github/workflows/build-core.yml b/.github/workflows/build-core.yml index 3937ecb..3ead7dc 100644 --- a/.github/workflows/build-core.yml +++ b/.github/workflows/build-core.yml @@ -73,79 +73,32 @@ jobs: PR_DESCRIPTION: ${{ github.event.pull_request.body }} run: | # Safely print the PR description using Node.js - node -e 'const prDesc = process.env.PR_DESCRIPTION; console.log("----- PR Description Start -----\n" + prDesc + "\n----- PR Description End -----");' - echo "$PR_DESCRIPTION" > /tmp/pr_description.txt - echo "PR DESCRIPTION saved to /tmp/pr_description.txt." - - # Save the template content to a file without modifying it - cat .github/pull_request_template.md > /tmp/template_content.txt - echo "Template content saved to /tmp/template_content.txt." - + 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 /tmp/template_content.txt > /dev/null; then + 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: Extract changelog info using Node.js - if: steps.check-changelog.outputs.check_commit == 'false' - id: extract-changelog - run: | - PR_DESCRIPTION=$(cat /tmp/pr_description.txt) - - # Check if "changelog:" exists in PR description - if echo "$PR_DESCRIPTION" | grep -q "VERSION:" && echo "$PR_DESCRIPTION" | grep -q "CHANGELOG:"; then - - # Extract content after "changelog:" using Node.js - CHANGELOG_TEXT=$(node -e "const lines = process.env.PR_DESCRIPTION.split('\n'); \ - for (const line of lines) { \ - if (line.startsWith('CHANGELOG: ')) { \ - console.log(line.substring('CHANGELOG: '.length)); \ - break; \ - } \ - }") - - # 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::$(echo "$CHANGELOG_TEXT" | base64)" - echo "::set-output name=version::$VERSION" - - else - 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 - - env: - PR_DESCRIPTION: ${{ env.PR_DESCRIPTION }} - - name: Check PR body against changelog if: steps.check-changelog.outputs.check_commit == 'false' + id: extract-changelog run: | - ESCAPED_CHANGELOG=$(echo "${{ steps.extract-changelog.outputs.changelog }}" | base64 -d) - echo "$ESCAPED_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 "zowe-robot@users.noreply.github.com" 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 @@ -225,4 +178,4 @@ jobs: pax-name: zlux-core - name: '[Prep 7] deploy' - uses: zowe-actions/zlux-builds/core/deploy@v2.x/main \ No newline at end of file + uses: zowe-actions/zlux-builds/core/deploy@v2.x/main diff --git a/.github/workflows/set-changelog.js b/.github/workflows/set-changelog.js new file mode 100644 index 0000000..32f620c --- /dev/null +++ b/.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'); +}