check-and-ebook.yml

# This workflow performs
# check: Quality checks on chapter text and code upon new commits and PRs.
# make: Makes eBooks if .tex files have changed.
# upload: Uploads the artifacts to release WorkInProgress, but only for push into main branch.

name: Check and Make eBook

# This workflow runs upon
# - manual triggering
# - create new PR (check, make)
# - push to main (check, make, upload)

on:
  workflow_dispatch:
  pull_request:
    branches: ["main"]
  push:
    branches: ["main"]

jobs:
  check:
    runs-on: ubuntu-24.04
    outputs:
      cache-hit: ${{ steps.cache-lookup.outputs.cache-hit }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          fetch-depth: 1 # 0 if you want to push to repo

      - name: Calculate hash on chapters/*.tex
        id: calculate-hash
        run: |
          echo "hash=${{ hashFiles('chapters/*.tex') }}" >> $GITHUB_OUTPUT
          touch hash-chapters.txt

      - name: Cache lookup
        id: cache-lookup
        uses: actions/cache@v4
        with:
          path: hash-chapters.txt
          key: chapter-hash-for-ebook-${{ github.ref_name }}-${{ steps.calculate-hash.outputs.hash }}

      - name: Preparations
        run: ln -s python-requirements.txt requirements.txt

      - name: Python set up
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: "pip"

      - name: Python packages
        run: pip install -r python-requirements.txt

      - name: Run pytest unittests
        run: pytest

      - name: Check chapters for known issues
        run: python3 -O scripts/check_chapters.py

      - name: Check pre-commit tests
        uses: pre-commit/action@v3.0.1

  make:
    needs: check
    # do not run for unchanged tex files
    if: needs.check.outputs.cache-hit != 'true'

    runs-on: ubuntu-24.04

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          fetch-depth: 1 # 0 if you want to push to repo

      - name: Preparations
        run: ln -s python-requirements.txt requirements.txt

      - name: Python set up
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: "pip"

      - name: Install Python packages
        run: pip install -r python-requirements.txt

      #  - name: setup environment to DE lang
      #    run: |
      #      cd /usr/share/locales
      #      sudo ./install-language-pack de_DE.UTF-8

      - name: ls before
        run: |
          pwd
          ls -l

      - name: Speed up apt-get steps
        uses: abbbi/github-actions-tune@v1

      - name: Install apt packages using cache
        uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: texlive-extra-utils pandoc calibre imagemagick ghostscript
          version: 1.0
          # execute_install_scripts: true

      - name: Install ImageMagick to fix caching issue
        # since cache does not properly work / "convert" not found
        run: |
          sudo apt-get install imagemagick

      - name: Print versions
        run: |
          cat /etc/os-release
          # xelatex -v
          # latexmk -v
          calibre --version
          pandoc --version
          ebook-convert --version
          python3 --version

      - name: Make eBooks
        run: |
          wget --quiet https://github.com/${{ github.repository }}/releases/latest/download/hpmor.html -O hpmor-prev.html
          wget --quiet https://github.com/${{ github.repository }}/releases/latest/download/hpmor.pdf -O hpmor.pdf
          sh scripts/make_ebooks.sh > /dev/null

      - name: Compare to previous hpmor.html
        run: |
          diff -U 0 -s hpmor-prev.html hpmor.html > hpmor-html-diff.log || true

      - name: ls after
        run: |
          pwd
          ls -al

      - name: Upload eBooks as artifact
        uses: actions/upload-artifact@v4
        with:
          name: ebooks
          path: |
            ./hpmor-html-diff.log
            ./hpmor.docx
            ./hpmor.epub
            ./hpmor.fb2
            ./hpmor.html
            ./hpmor.mobi
          retention-days: 14

  #
  # upload to release WorkInProgress
  #
  upload:
    needs: make
    # only for main branch and actions push or manual run
    if: github.ref == 'refs/heads/main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')

    permissions:
      contents: write

    runs-on: ubuntu-24.04

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Get tags
        run: git fetch --tags origin

      - name: Update tag WorkInProgress
        run: |
          git tag -d WorkInProgress || true
          git tag WorkInProgress
          git push origin -f WorkInProgress

      - name: Download eBooks artifact
        uses: actions/download-artifact@v4
        with:
          name: ebooks

      - name: Publish eBooks to release WorkInProgress
        uses: softprops/action-gh-release@v2
        with:
          tag_name: WorkInProgress
          prerelease: true
          files: |
            ./hpmor-html-diff.log
            ./hpmor.docx
            ./hpmor.epub
            ./hpmor.fb2
            ./hpmor.html
            ./hpmor.mobi