WIP: sketch out a reference API #2658
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Haskell CI | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| merge_group: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Build and test | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| ghc: ["8.10.7", "9.2.8", "9.4.8", "9.6.4", "9.8.2", "9.10.1"] | |
| cabal: ["3.10.2.1"] | |
| os: [ubuntu-latest, windows-latest, macOS-latest] | |
| cabal-flags: [""] | |
| no-debug: [""] | |
| exclude: | |
| - ghc: "8.10.7" | |
| os: macOS-latest | |
| include: | |
| - ghc: "8.10.7" | |
| cabal: "3.10.2.1" | |
| os: macOS-13 | |
| - ghc: "9.6.4" | |
| cabal: "3.10.2.1" | |
| os: ubuntu-latest | |
| cabal-flags: "+serialblockio" | |
| - ghc: "9.6.4" | |
| cabal: "3.10.2.1" | |
| os: ubuntu-latest | |
| no-debug: "no-debug" | |
| timeout-minutes: 60 | |
| steps: | |
| - name: CPU info (macOS) | |
| if: ${{ startsWith(matrix.os, 'macOS') }} | |
| run: sysctl -a machdep.cpu | |
| - name: CPU info (Linux) | |
| if: ${{ startsWith(matrix.os, 'ubuntu') }} | |
| run: cat /proc/cpuinfo | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Haskell | |
| id: setup-haskell | |
| uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| cabal-update: true | |
| - name: Install liburing (on Linux) | |
| id: setup-liburing | |
| if: ${{ startsWith(matrix.os, 'ubuntu') }} | |
| run: | | |
| sudo apt-get update || true | |
| sudo apt-get -y install liburing-dev | |
| sudo apt-get -y install librocksdb-dev | |
| - name: Configure the build | |
| run: | | |
| cabal configure --enable-tests --enable-benchmark --ghc-options="-Werror" --flag="${{ matrix.cabal-flags }}" | |
| cat cabal.project.local | |
| - name: Configure the build (no-debug) | |
| if: ${{ matrix.no-debug }} | |
| run: | | |
| echo "" > cabal.project.debug | |
| cat cabal.project.debug | |
| - name: Record cabal dependencies | |
| id: record-deps | |
| run: | | |
| cabal build all --dry-run | |
| - name: "Restore cache" | |
| uses: actions/cache/restore@v4 | |
| id: restore-cabal-cache | |
| env: | |
| cache-name: cache-cabal-build-130824 | |
| with: | |
| path: ${{ steps.setup-haskell.outputs.cabal-store }} | |
| key: ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}-${{ hashFiles('**/cabal.project.debug') }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}- | |
| ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}- | |
| ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}- | |
| - name: Install cabal dependencies | |
| id: build-dependencies | |
| run: cabal build --only-dependencies --enable-tests --enable-benchmarks all | |
| - name: "Save cache" | |
| uses: actions/cache/save@v4 | |
| id: save-cabal-cache | |
| # Note: cache-hit will be set to true only when cache hit occurs for the | |
| # exact key match. For a partial key match via restore-keys or a cache | |
| # miss, it will be set to false. | |
| if: steps.build-dependencies.outcome == 'success' && steps.restore-cabal-cache.outputs.cache-hit != 'true' | |
| with: | |
| path: ${{ steps.setup-haskell.outputs.cabal-store }} | |
| key: ${{ steps.restore-cabal-cache.outputs.cache-primary-key }} | |
| - name: Build | |
| run: cabal build all | |
| # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable | |
| - name: Set test timeout (Unix) | |
| if: ${{ startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macOS') }} | |
| run: | | |
| echo "TASTY_TIMEOUT=5m" >> "$GITHUB_ENV" | |
| # https://github.com/actions/runner/issues/2281#issuecomment-1326748709 | |
| - name: Set test timeout (Windows) | |
| if: ${{ startsWith(matrix.os, 'windows') }} | |
| run: | | |
| echo "TASTY_TIMEOUT=5m" >> "$env:GITHUB_ENV" | |
| - name: Run tests | |
| run: | | |
| cabal test -j1 --test-show-details=direct all | |
| - name: cabal-docspec | |
| if: ${{ startsWith(matrix.os, 'ubuntu') }} | |
| run: | | |
| curl -sL https://github.com/phadej/cabal-extras/releases/download/cabal-docspec-0.0.0.20240414/cabal-docspec-0.0.0.20240414-x86_64-linux.xz > cabal-docspec.xz | |
| echo '2d18a3f79619e8ec5f11870f926f6dc2616e02a6c889315b7f82044b95a1adb9 cabal-docspec.xz' | sha256sum -c - | |
| xz -d < cabal-docspec.xz > ./cabal-docspec | |
| chmod a+x ./cabal-docspec | |
| ./cabal-docspec --extra-package lsm-tree:prototypes -XOverloadedStrings -XNumericUnderscores -XTypeApplications | |
| # Check formatting for Haskell files | |
| stylish-haskell: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| ghc: ["9.6.4"] | |
| cabal: ["3.10.2.1"] | |
| os: [ubuntu-latest] | |
| # Fix the index-state so we can get proper caching effects. Change this to a | |
| # more recent time if you want to use a newer version of stylish-haskell, or | |
| # if you want stylish-haskell to use updated dependencies. | |
| # | |
| # We use this environment variable in the primary key of our caches, and as | |
| # an argument to cabal install. This ensures that we never rebuild | |
| # dependencies because of newly uploaded packages unless we want to. | |
| env: | |
| hackage-index-state: "2024-04-10T14:36:07Z" | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install system dependencies (apt-get) | |
| run: | | |
| sudo apt-get update || true | |
| sudo apt-get -y install fd-find | |
| - name: Setup Haskell | |
| id: setup-haskell | |
| uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| cabal-update: false | |
| - name: Cabal update | |
| run: cabal update | |
| - name: Setup cabal bin path | |
| run: echo "$HOME/.cabal/bin" >> $GITHUB_PATH | |
| - name: Cache cabal store | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-cabal-stylish | |
| with: | |
| path: ${{ steps.setup-haskell.outputs.cabal-store }} | |
| key: ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ env.hackage-index-state }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}- | |
| - name: Install stylish-haskell | |
| run: cabal install --ignore-project --index-state="${{ env.hackage-index-state }}" stylish-haskell --constraint 'stylish-haskell == 0.14.6.0' | |
| - name: Record stylish-haskell version | |
| run: | | |
| which stylish-haskell | |
| stylish-haskell --version | |
| - name: Run stylish-haskell | |
| run: | | |
| ./scripts/format-stylish-fd.sh | |
| git diff --exit-code | |
| # Check formatting for cabal files | |
| cabal-fmt: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| ghc: ["9.6.4"] | |
| cabal: ["3.10.2.1"] | |
| os: [ubuntu-latest] | |
| # See the comment on the hackage-index-state environment variable for the | |
| # stylish-haskell job. | |
| env: | |
| hackage-index-state: "2024-04-10T14:36:07Z" | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install system dependencies (apt-get) | |
| run: | | |
| sudo apt-get update || true | |
| sudo apt-get -y install fd-find | |
| - name: Setup Haskell | |
| id: setup-haskell | |
| uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| cabal-update: false | |
| - name: Cabal update | |
| run: cabal update | |
| - name: Setup cabal bin path | |
| run: echo "$HOME/.cabal/bin" >> $GITHUB_PATH | |
| - name: Cache cabal store | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-cabal-cabal-fmt-11 | |
| with: | |
| path: ${{ steps.setup-haskell.outputs.cabal-store }} | |
| key: ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}-${{ env.hackage-index-state }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.ghc }}-${{ env.cache-name }}- | |
| - name: Install cabal-fmt | |
| run: cabal install --ignore-project cabal-fmt --index-state="${{ env.hackage-index-state }}" --constraint 'cabal-fmt == 0.1.11' | |
| - name: Record cabal-fmt version | |
| run: | | |
| which cabal-fmt | |
| cabal-fmt --version | |
| - name: Run cabal-fmt | |
| run: | | |
| ./scripts/format-cabal-fd.sh | |
| git diff --exit-code | |
| # Check cabal files | |
| cabal-check: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| ghc: ["9.6.4"] | |
| cabal: ["3.10.2.1"] | |
| os: [ubuntu-latest] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Haskell | |
| id: setup-haskell | |
| uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| cabal-update: false | |
| - name: Cabal update | |
| run: cabal update | |
| - name: Run cabal check | |
| run: | | |
| ./scripts/check-cabal.sh | |
| # HLint | |
| hlint: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: 'Set up HLint' | |
| uses: haskell-actions/hlint-setup@v2 | |
| with: | |
| version: '3.8' | |
| - name: 'Run HLint' | |
| uses: haskell-actions/hlint-run@v2 | |
| with: | |
| path: '[ "src/", "test/", "src-extras/", "src-fcntl-nocache/", "src-kmerge/", "src-mcg/", "src-monkey/", "src-rocksdb/" ]' | |
| fail-on: suggestion |