build-core.yml

name: Build Core
on:
  push:
    branches:
      - v2.x/staging
  pull_request:
    types: [opened, reopened, synchronize]

  workflow_dispatch:
    inputs: 
      ZLUX_APP_MANAGER:
        description: 'zlux-app-manager PR number'
        required: false
      ZLUX_APP_SERVER:
        description: 'zlux-app-server PR number'
        required: false
      ZLUX_BUILD:
        description: 'zlux-build PR number'
        required: false
      ZLUX_PLATFORM:
        description: 'zlux-platform PR number'
        required: false
        
      ZLUX_SERVER_FRAMEWORK:
        description: 'zlux-server-framework PR number'
        required: false
      ZLUX_SHARED:
        description: 'zlux-shared PR number'
        required: false
      DEFAULT_BRANCH:
        description: 'please enter the default branch you would like to build with, default will be v2.x/staging'
        required: false
        default: 'v2.x/staging'

jobs:
  check-permission:
    runs-on: ubuntu-latest
    steps:
      # this action will fail the whole workflow if permission check fails
      - name: check permission
        uses: zowe-actions/shared-actions/permission-check@main
        with:
          user: ${{ github.actor }}
          github-repo: ${{ github.repository }}
          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'
        id: compare-with-template
        run: |
          PR_DESCRIPTION="${{ github.event.pull_request.body }}"
          echo "$PR_DESCRIPTION" > /tmp/pr_description.txt
          echo "PR DESCRIPTION saved to /tmp/pr_description.txt."
          cat /tmp/pr_description.txt
            
          # Save the template content to a file
          TEMPLATE_CONTENT=$(sed 's/"//g' .github/pull_request_template.md)
          echo "$TEMPLATE_CONTENT" > /tmp/template_content.txt
          echo "Template content saved to /tmp/template_content.txt."
          cat /tmp/template_content.txt
            
          # Use diff to compare the two files
          if diff -wB /tmp/pr_description.txt /tmp/template_content.txt > /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
        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:"
            CHANGELOG_TEXT=$(echo $PR_DESCRIPTION | sed -n 's/.*CHANGELOG: \(.*\)/\1/p')
            
            # Check if extracted CHANGELOG_TEXT is empty or identical to the template content
            TEMPLATE_CONTENT=$(cat /tmp/template_content.txt)
            if [ -z "$CHANGELOG_TEXT" ] || [ "$CHANGELOG_TEXT" == "$TEMPLATE_CONTENT" ]; then
              echo "The changelog information after 'CHANGELOG:' cannot be empty or identical to pull_request_template.md."
              exit 1
            fi
      
            # 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.\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 PR body against changelog
        if: steps.check-changelog.outputs.check_commit == 'false'
        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
            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
          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:
    runs-on: ubuntu-latest
    needs: check-permission
    steps:
      - name: '[Prep 1] Cache node modules'
        uses: actions/cache@v2
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: |
            ~/.npm
            ~/.nvm/.cache
            ~/.nvm/versions
          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:
          node-version: 16.15.0

      - name: '[Prep 3] Setup jFrog CLI'
        uses: jfrog/setup-jfrog-cli@v2
        env:
          JF_ARTIFACTORY_1: ${{ secrets.JF_ARTIFACTORY_TOKEN }}

      - name: '[Prep 4] prepare workflow'
        uses: zowe-actions/zlux-builds/core/prepare@v2.x/main
        with:
          github-user: ${{ secrets.ZOWE_ROBOT_USER }}
          github-password: ${{ secrets.ZOWE_ROBOT_TOKEN }}
          github-email: ${{ secrets.ZOWE_ROBOT_EMAIL }}
          github-branch: ${{ github.event.inputs.BRANCH_NAME }}
          default-base: ${{ github.event.inputs.DEFAULT_BRANCH }}

      - name: '[Prep 5] build'
        uses: zowe-actions/zlux-builds/core/build@v2.x/main
        with:
          zlux-app-manager: ${{ github.event.inputs.ZLUX_APP_MANAGER }}
          zlux-app-server: ${{ github.event.inputs.ZLUX_APP_SERVER }}
          zlux-build: ${{ github.event.inputs.ZLUX_BUILD }}
          zlux-platform: ${{ github.event.inputs.ZLUX_PLATFORM }}
          zlux-server-framework: ${{ github.event.inputs.ZLUX_SERVER_FRAMEWORK }}
          zlux-shared: ${{ github.event.inputs.ZLUX_SHARED }}

      - name: '[Prep 6] packaging'
        uses: zowe-actions/zlux-builds/core/package@v2.x/main
        with:
          pax-ssh-username: ${{ secrets.SSH_MARIST_USERNAME }}
          pax-ssh-password: ${{ secrets.SSH_MARIST_RACF_PASSWORD }}
          pax-name: zlux-core

      - name: '[Prep 7] deploy'
        uses: zowe-actions/zlux-builds/core/deploy@v2.x/main