review.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Diff review for markup

on:
  pull_request:
    branches: [ main ]

jobs:

  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

  download_repos:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout CredData
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.sha }}

      - name: Markup hashing
        run: |
          md5sum snapshot.yaml >head_checksums.md5
          for f in $(find meta -type f|sort); do md5sum $f; done >>head_checksums.md5
          for f in $(find . -maxdepth 1 -type f -name "*.py"|sort); do md5sum $f; done >>head_checksums.md5
          cat head_checksums.md5
          sha256sum head_checksums.md5

      - name: Cache head review
        id: cache-data
        uses: actions/cache@v4
        with:
          path: |
            review_head.txt
            review_head.html
          key: cred-data-${{ hashFiles('head_checksums.md5') }}

      - name: Cache tmp
        if: steps.cache-data.outputs.cache-hit != 'true'
        id: cache-tmp
        uses: actions/cache@v4
        with:
          path: tmp
          key: cred-data-${{ hashFiles('snapshot.yaml') }}

      - name: install ansi2html
        if: steps.cache-data.outputs.cache-hit != 'true'
        run: sudo apt update && sudo apt install colorized-logs

      - name: Set up Python 3.8
        if: steps.cache-data.outputs.cache-hit != 'true'
        uses: actions/setup-python@v4
        with:
          python-version: "3.8"

      - name: Produce review report from HEAD
        if: steps.cache-data.outputs.cache-hit != 'true'
        run: |
          python -m pip install --upgrade pip
          python -m pip install --requirement requirements.txt
          # skip extra hints from git
          git config --global init.defaultBranch work
          python download_data.py --data_dir data --jobs $(nproc)
          python review_data.py &>review_head.txt
          ansi2html --style 'pre {font-family: monospace; font-size: large}' <review_head.txt  >review_head.html

      - name: Upload artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: review_head
          path: |
            review_head.txt
            review_head.html

  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

  review_base:

    needs: [ download_repos ]

    runs-on: ubuntu-latest

    steps:

      - name: Checkout CredData
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.base.sha }}

      - name: Markup hashing
        run: |
          md5sum snapshot.yaml >base_checksums.md5
          for f in $(find meta -type f|sort); do md5sum $f; done >>base_checksums.md5
          for f in $(find . -maxdepth 1 -type f -name "*.py"|sort); do md5sum $f; done >>base_checksums.md5
          cat base_checksums.md5
          sha256sum base_checksums.md5

      - name: Cache base review
        id: cache-data
        uses: actions/cache@v4
        with:
          path: |
            review_base.txt
            review_base.html
          key: cred-data-${{ hashFiles('base_checksums.md5') }}

      - name: Cache tmp
        if: steps.cache-data.outputs.cache-hit != 'true'
        id: cache-tmp
        uses: actions/cache@v4
        with:
          path: tmp
          key: cred-data-${{ hashFiles('snapshot.yaml') }}

      - name: install ansi2html
        if: steps.cache-data.outputs.cache-hit != 'true'
        run: sudo apt update && sudo apt install colorized-logs

      - name: Set up Python 3.8
        if: steps.cache-data.outputs.cache-hit != 'true'
        uses: actions/setup-python@v4
        with:
          python-version: "3.8"

      - name: Produce review report from HEAD
        if: steps.cache-data.outputs.cache-hit != 'true'
        run: |
          python -m pip install --upgrade pip
          python -m pip install --requirement requirements.txt
          python download_data.py --data_dir data
          python review_data.py &>review_base.txt
          ansi2html --style 'pre {font-family: monospace; font-size: large}' <review_base.txt  >review_base.html

      - name: Upload artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: review_base
          path: |
            review_base.txt
            review_base.html

  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

  diff_review:

    needs: [ download_repos, review_base ]

    runs-on: ubuntu-latest

    steps:

      - name: install ansi2html
        run: sudo apt update && sudo apt install colorized-logs

      - name: Download all workflow run artifacts
        uses: actions/download-artifact@v4

      - name: Get diff for review
        run: |
          # in case of difference - diff returns failure
          if ! diff --color=auto review_base/review_base.txt review_head/review_head.txt &>review_diff.txt; then
            cat review_diff.txt | ansi2html --style 'pre {font-family: monospace; font-size: large}' >review_diff.html
          else
            touch review_diff.html
          fi

      - name: Upload artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: review_diff
          path: |
            review_diff.txt
            review_diff.html

  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #