CI.yml

name: CI

# Trigger the workflow on push to main, or on pull request
on:
  push:
    branches:
      - main
  pull_request:

jobs:
  test-action:
    name: "Test the pkg-release action"
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        package: [ "gap-actions/ActionTestGAPDocPackage", "gap-actions/ActionTestOldDocPackage" ]
        affix: [ 1, 2 ] # Run each package twice, to check reproducibility
        include:
          - package: "gap-actions/ActionTestGAPDocPackage"
            force: true
          - package: "gap-actions/ActionTestOldDocPackage"
            force: false
    
    steps:
      # the order of the checkout actions is important because all contents of
      # the target folder of the checkout action is removed
      - name: "Clone the package"
        uses: actions/checkout@v6
        with:
          repository: ${{ matrix.package }}

      - name: "Fake the package's date so it does not get rejected later on"
        shell: bash
        if: ${{ !matrix.force }}
        run: |
          DATE=$(date +%d/%m/%Y)
          sed -i -E "s|(Date[[:space:]]*:?=[[:space:]]*['\"]).*(['\"])|\1${DATE}\2|" "PackageInfo.g"

      - name: "Check out this repository"
        uses: actions/checkout@v6
        with:
          path: .this-action/

      - name: "Setup GAP"
        uses: gap-actions/setup-gap@v3
          
      - name: "Build manual"
        uses: gap-actions/build-pkg-docs@v2
        with:
          use-latex: true

      - name: "Make a release"
        uses: ./.this-action/
        with:
          dry-run: true
          force: ${{ matrix.force }}
          _affix: "-${{ matrix.affix }}"

  check-reproducibility:
    name: "Check if builds are reproducible"
    runs-on: ubuntu-latest
    needs: test-action
    strategy:
      fail-fast: false
      matrix:
        package: [ "ActionTestGAPDocPackage", "ActionTestOldDocPackage" ]
    steps:
    
      - name: "Download releases"
        uses: actions/download-artifact@v8
        with:
          pattern: "Release_assets_for_${{ matrix.package }}*"
          path: ${{ runner.temp }}
          
      - name: "Compare releases"
        shell: bash
        working-directory: ${{ runner.temp }}
        run: |
          # Move downloaded assets
          # The .zip is not an extension but part of the directory name
          mv Release_assets_for_*-1.zip v1
          mv Release_assets_for_*-2.zip v2

          error_found=false
          for EXT in .tar.gz .tar.bz2 .zip; do
            for file1 in v1/*"$EXT"; do
              file2="v2/$(basename "$file1")"

              # Calculate sha256 checksums
              chk1=$(sha256sum "$file1" | cut -d' ' -f1)
              chk2=$(sha256sum "$file2" | cut -d' ' -f1)
            
              if [[ "$chk1" != "$chk2" ]]; then
                echo "::error::Checksum mismatch for ${EXT} archives"
                echo "v1: $chk1"
                echo "v2: $chk2"
                error_found=true
              else
                echo "${EXT} archives are reproducible"
              fi
            done
          done

          if ${error_found}; then
            exit 1
          fi

  test-scripts:
    name: "Test the scripts used by this action"
    runs-on: ubuntu-slim

    steps:

      - name: "Check out this repository"
        uses: actions/checkout@v6

      - name: "Shellcheck"
        shell: bash
        working-directory: scripts
        run: shellcheck -o all *.sh

      - name: "Test check_filenames.sh"
        shell: bash
        working-directory: scripts
        run: |
          mkdir -p filename-dir/doc
          cd filename-dir
          touch :q \\Users\\GillBates AUX COM².tar.gz period. space\  DOC \
            PackageInfo.g doc/manual.pdf manual.pdf README readme.txt auxiliary .gaplint.yml
          ../check_filenames.sh > $RUNNER_TEMP/filenames_run.txt || true # suppress expected error here
          diff $RUNNER_TEMP/filenames_run.txt - <<EOF
          Checking for Windows-incompatible names
            Illegal character in name: :q
            Reserved Windows name: AUX
            Reserved Windows name: COM².tar.gz
            Illegal character in name: \Users\GillBates
            Duplicate filename: DOC and doc
            Name ends with space or period: period.
            Name ends with space or period: space 
          EOF

      - name: "Test check_absolute_paths.sh"
        shell: bash
        working-directory: scripts
        run: |
          mkdir -p paths-dir/doc
          cd paths-dir
          ../check_absolute_paths.sh > $RUNNER_TEMP/absolute_paths_run.txt # empty folder, so should not give error
          echo "<a href=\"/home/runner/gap/pkg/awesomepackage/doc/chap66_mj.html#ABC123\">Link</a>" > doc/chap1_mj.html
          echo "<a href=\"file:///home/runner/gap/pkg/awesomepackage/doc/chap66_mj.html#ABC123\">Link</a>" > doc/chap2_mj.html
          echo "<a href=\"../../../pkg/awesomepackage/doc/chap66_mj.html#ABC123\">Link</a>" > doc/chap3_mj.html
          ../check_absolute_paths.sh > $RUNNER_TEMP/absolute_paths_run.txt || true # suppress expected error here
          diff <(sort $RUNNER_TEMP/absolute_paths_run.txt) - <<EOF
          ./doc/chap1_mj.html
          ./doc/chap2_mj.html
          EOF

      - name: "Test check_symlinks.sh"
        shell: bash
        working-directory: scripts
        run: |
          mkdir -p symlinks-dir
          cd symlinks-dir
          echo "THIS FILE IS NOT A SYMLINK" > actual.file
          ../check_symlinks.sh > $RUNNER_TEMP/symlinks_run.txt # should not give error
          ln -s actual.file sym.link
          ../check_symlinks.sh > $RUNNER_TEMP/symlinks_run.txt || true # suppress expected error here
          diff <(sort $RUNNER_TEMP/symlinks_run.txt) - <<EOF
          ./sym.link
          EOF

      - name: "Test check_date.sh"
        shell: bash
        working-directory: scripts
        run: |
          if   ! ./check_date.sh "$(date +%Y-%m-%d)"                 \
            || ! ./check_date.sh "$(date -d "1 day ago" +%Y-%m-%d)"  \
            || ! ./check_date.sh "$(date -d "1 day" +%Y-%m-%d)"      \
            ||   ./check_date.sh "$(date -d "2 days ago" +%Y-%m-%d)" \
            ||   ./check_date.sh "$(date -d "2 days" +%Y-%m-%d)"
          then
            exit 1
          fi