new-changes-validation.yml

name: New changes validation

on:
  push:
    branches:
      - 'main'
  pull_request:

env:
  WORK_PATH: /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/

jobs:
  cache-V:
    runs-on: ubuntu-latest
    steps:
      # Because of problems with `setup-v` action, when Vlang version is specified, and also because of V evolving continuously,
      # and you need the latest commit of V most of the time, we always use the latest V version from the master branch
      # and getting it from the cache on the start of a job is not possible (because you need to know a version of V to cache it).
      # This step should be uncommented when Vlang will be stable and caching will be possible.
#      - name: Check if V is cached
#        id: check-v-cache
#        uses: actions/cache/restore@v3
#        with:
#          path: ${{ env.WORK_PATH }}vlang/
#          key: vlang-0.3.3-weekly.2023.08

      - name: Install V
        id: install-v
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Set V_VERSION environment variable
        run: echo "V_VERSION=$(v -v)" >> $GITHUB_ENV

      - name: Cache Vlang
        uses: actions/cache/save@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}

  simple-build:
    needs: cache-V
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Build
        run: v .

  tests:
    needs: simple-build
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Run tests
        run: v test .

  cache-clang:
    needs: tests
    runs-on: ubuntu-latest
    steps:
      - name: Check if LLVM and Clang is cached
        id: check-llvm-cache
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}llvm
          key: llvm-15

      - if: ${{ steps.check-llvm-cache.outputs.cache-hit != 'true' }}
        name: Install LLVM and Clang
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: '15'

      - if: ${{ steps.check-llvm-cache.outputs.cache-hit != 'true' }}
        name: Cache LLVM and Clang
        uses: actions/cache/save@v3
        with:
          path: ${{ env.WORK_PATH }}llvm
          key: llvm-15

  different-compilers:
    needs: cache-clang
    runs-on: ubuntu-latest
    strategy:
      matrix:
        compiler: [ gcc, clang ]
        optimization: [ null , -prod ]
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - if: ${{ matrix.compiler == 'gcc' }}
        name: Set up GCC
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y build-essential

      - if: ${{ matrix.compiler == 'clang' }}
        name: Restore LLVM and Clang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}llvm
          key: llvm-15
          fail-on-cache-miss: true

      - if: ${{ matrix.compiler == 'clang' }}
        name: Setup LLVM and Clang
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: '15'
          cached: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: ${{ matrix.compiler }} ${{ matrix.optimization }} build
        run: v -cc ${{ matrix.compiler }} ${{ matrix.optimization }} .

  clang-sanitizers:
    needs: different-compilers
    runs-on: ubuntu-latest
    strategy:
      matrix:
        sanitizer: [ address, memory, undefined, leak ] # TODO: thread sanitizer was removed due to strange warnings. It should be fixed and turned on.
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Restore LLVM and Clang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}llvm
          key: llvm-15
          fail-on-cache-miss: true

      - name: Setup LLVM and Clang
        uses: KyleMayes/install-llvm-action@v1
        with:
          version: '15'
          cached: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Clang ${{ matrix.sanitizer }} sanitizer
        run: v -cc clang -cflags -fsanitize=${{ matrix.sanitizer }} test .

  gcc-sanitizers:
    needs: different-compilers
    runs-on: ubuntu-latest
    strategy:
      matrix:
        sanitizer: [ leak ]  # TODO: thread sanitizer was removed due to strange warnings. It should be fixed and turned on.
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Set up GCC
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y build-essential

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: GCC ${{ matrix.sanitizer }} sanitizer
        run: v -cc gcc -cflags -fsanitize=${{ matrix.sanitizer }} test .

  gcc-address-sanitizers:
    needs: different-compilers
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Set up GCC
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y build-essential

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: GCC address sanitizer
        run: v -cc gcc -cflags -fsanitize=address -cflags -fsanitize-address-use-after-scope -cflags -fsanitize=pointer-compare -cflags -fsanitize=pointer-subtract test .

  gcc-undefined-sanitizers:
    needs: different-compilers
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Set up GCC
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y build-essential

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: GCC undefined sanitizer
        run: v -cc gcc -cflags -fsanitize=undefined -cflags -fsanitize=shift -cflags -fsanitize=shift-exponent -cflags -fsanitize=shift-base -cflags -fsanitize=integer-divide-by-zero -cflags -fsanitize=unreachable -cflags -fsanitize=vla-bound -cflags -fsanitize=null -cflags -fsanitize=return -cflags -fsanitize=signed-integer-overflow -cflags -fsanitize=bounds -cflags -fsanitize=bounds-strict -cflags -fsanitize=alignment -cflags -fsanitize=object-size -cflags -fsanitize=float-divide-by-zero -cflags -fsanitize=float-cast-overflow -cflags -fsanitize=nonnull-attribute -cflags -fsanitize=returns-nonnull-attribute -cflags -fsanitize=bool -cflags -fsanitize=enum -cflags -fsanitize=vptr -cflags -fsanitize=pointer-overflow -cflags -fsanitize=builtin test .

  linux-to-other-platforms-compilation:
    needs: [clang-sanitizers, gcc-sanitizers, gcc-address-sanitizers, gcc-undefined-sanitizers]
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Install MinGW-w64
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y gcc-mingw-w64-x86-64

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Build Windows executable
        run: v -os windows .

  check-formatting:
    needs: [linux-to-other-platforms-compilation]
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Check formatting
        run: v fmt -verify .

  check-docs:
    needs: [linux-to-other-platforms-compilation]
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Check markdown line length & code examples
        run: v check-md -hide-warnings .

      - name: Check public methods without documentation
        run: v missdoc --exclude src/tests/ --verify .

  vet-check:
    needs: [linux-to-other-platforms-compilation]
    runs-on: ubuntu-latest
    steps:
      - name: Restore Vlang
        uses: actions/cache/restore@v3
        with:
          path: ${{ env.WORK_PATH }}vlang/
          key: vlang-${{ env.V_VERSION }}
          fail-on-cache-miss: true

      - name: Install V
        uses: vlang/setup-v@v1.3
        with:
          check-latest: true

      - name: Checkout ${{ github.event.repository.name }}
        uses: actions/checkout@v3

      - name: Install project dependencies
        run: v install

      - name: Install graphic libs dependencies
        run: |
          sudo apt-get update
          sudo apt-get install --quiet -y libxi-dev libxcursor-dev libgl-dev

      - name: Check code with vet
        run: v vet -W .