Add nightly ci and cancel conflicting runs #1712
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 | |
| # If it's a scheduled (for us: nightly) build, set the name of this run to a static value, so we can identify it easier. | |
| # Otherwise, replicate the default run name: either the PR title if it exists, or the commit message otherwise. | |
| run-name: | | |
| ${{github.event_name == 'schedule' && 'Haskell CI - NIGHTLY' | |
| || github.event.pull_request.title == '' && github.event.head_commit.message | |
| || github.event.pull_request.title}} | |
| on: | |
| push: | |
| branches: [ "master", "release/**" ] | |
| pull_request: | |
| branches: [ "**" ] | |
| schedule: | |
| # "Nightly" builds: Every day at 06:00 UTC | |
| - cron: '0 6 * * *' | |
| # for running the workflow manually - useful for branches without PRs, for which jobs don't get ran automatically | |
| workflow_dispatch: | |
| inputs: | |
| nightly: | |
| description: Run with the same settings as a nightly build | |
| type: boolean | |
| default: false | |
| # Cancel running workflows when a new workflow on the same PR or branch is started, | |
| # but put scheduled workflows into their own group | |
| concurrency: | |
| group: ${{ | |
| format('{0}-{1}{2}', | |
| github.workflow, | |
| github.event.pull_request.number || github.ref, | |
| github.event_name == 'schedule' && '-scheduled' || '')}} | |
| cancel-in-progress: true | |
| jobs: | |
| whitespace: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| strategy: | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Trailing whitespace check | |
| if: matrix.os != 'windows-latest' | |
| run: | | |
| offenders="$(git grep "\s$" -- *.hs *.c *.h *.nix *.yml *.md || true)"; | |
| if [ -n "${offenders}" ]; then | |
| echo -e "Fix trailing whitespace in:\n" | |
| echo -n "${offenders}" | |
| exit 1 | |
| fi | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| ghc: ["8.10.7", "9.2.8", "9.6.6", "9.8.2", "9.10.1"] | |
| os: [ubuntu-latest, macos-13, macos-latest, windows-latest] | |
| # GHC versions older than ghc-9.2 are not supported on macos-latest | |
| exclude: | |
| - os: macos-latest | |
| ghc: "8.10.7" | |
| - os: macos-13 | |
| ghc: "9.2.8" | |
| - os: macos-13 | |
| ghc: "9.6.6" | |
| - os: macos-13 | |
| ghc: "9.8.2" | |
| - os: macos-13 | |
| ghc: "9.10.1" | |
| env: | |
| # Modify this value to "invalidate" the cabal cache. | |
| CABAL_CACHE_VERSION: "2023-04-27" | |
| steps: | |
| - name: Install Haskell | |
| uses: input-output-hk/actions/haskell@latest | |
| id: setup-haskell | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: 3.12.1.0 | |
| - name: Install system dependencies | |
| uses: input-output-hk/actions/base@latest | |
| with: | |
| use-sodium-vrf: false # default is true | |
| - uses: actions/checkout@v4 | |
| - name: Cabal update | |
| run: cabal update | |
| - name: Configure build | |
| shell: bash | |
| run: | | |
| cp ".github/workflows/cabal.project.local.ci.$(uname -s)" cabal.project.local | |
| echo "# cabal.project.local" | |
| cat cabal.project.local | |
| # A dry run `build all` operation does *NOT* downlaod anything, it just looks at the package | |
| # indices to generate an install plan. | |
| - name: Build dry run | |
| run: cabal build all --enable-tests --dry-run --minimize-conflict-set | |
| # From the install plan we generate a dependency list. | |
| - name: Record dependencies | |
| id: record-deps | |
| run: | | |
| # The tests call out to msys2 commands. We generally do not want to mix toolchains, so | |
| # we are very deliberate about only adding msys64 to the path where absolutely necessary. | |
| ${{ (runner.os == 'Windows' && '$env:PATH=("C:\msys64\mingw64\bin;{0}" -f $env:PATH)') || '' }} | |
| cat dist-newstyle/cache/plan.json | jq -r '."install-plan"[].id' | sort | uniq > dependencies.txt | |
| # From the dependency list we restore the cached dependencies. | |
| # We use the hash of `dependencies.txt` as part of the cache key because that will be stable | |
| # until the `index-state` values in the `cabal.project` file changes. | |
| - name: Restore cached dependencies | |
| uses: actions/cache/restore@v4 | |
| id: cache | |
| with: | |
| path: | | |
| ${{ steps.setup-haskell.outputs.cabal-store }} | |
| dist-newstyle | |
| key: cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }} | |
| # Now we install the dependencies. If the cache was found and restored in the previous step, | |
| # this should be a no-op, but if the cache key was not found we need to build stuff so we can | |
| # cache it for the next step. | |
| - name: Install dependencies | |
| run: cabal build all --enable-tests --only-dependencies -j --ghc-option=-j4 | |
| # Always store the cabal cache. | |
| # This may fail (benign failure) if the cache key is already populated. | |
| - name: Cache Cabal store | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: | | |
| ${{ steps.setup-haskell.outputs.cabal-store }} | |
| dist-newstyle | |
| key: cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }} | |
| # Now we build. | |
| - name: Build [testing] | |
| run: cabal build all --enable-tests -j --ghc-option=-j4 | |
| - name: Run tests | |
| env: | |
| # these two are msys2 env vars, they have no effect on non-msys2 installs. | |
| MSYS2_PATH_TYPE: inherit | |
| MSYSTEM: MINGW64 | |
| run: cabal test all --enable-tests --test-show-details=direct -j1 | |
| - name: Build strict-checked-vars with invariants | |
| run: cabal build -f+checktvarinvariants -f+checkmvarinvariants strict-checked-vars | |
| - name: Save logs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ runner.os }}-${{ matrix.ghc }} Build & test logs | |
| path: | | |
| dist-newstyle/**/*.log | |
| # - name: Run benchmarks | |
| # run: cabal bench all --enable-tests | |
| # Uncomment the following back in for debugging. Remember to launch a `pwsh` from | |
| # the tmux session to debug `pwsh` issues. And be reminded that the `/msys2` and | |
| # `/msys2/mingw64` paths are not in PATH by default for the workflow, but tmate | |
| # will put them in. | |
| # You may also want to run | |
| # | |
| # $env:PATH=("C:\Program Files\PowerShell\7;{0}" -f $env:ORIGINAL_PATH) | |
| # | |
| # to restore the original path. Do note that some test might need msys2 | |
| # and will silently fail if msys2 is not in path. See the "Run tests" step. | |
| # | |
| # - name: Setup tmate session | |
| # if: ${{ failure() }} | |
| # uses: mxschmitt/action-tmate@v4 | |
| # with: | |
| # limit-access-to-actor: true | |
| - name: Cache HLS artifacts (used to speed up GitHub Codespaces bootstrapping) | |
| if: runner.os == 'Linux' && (matrix.ghc == '8.10.7' || matrix.ghc == '9.6.6') | |
| uses: input-output-hk/actions/cache@latest | |
| with: | |
| ghc_version: ${{ matrix.ghc == '8.10.7' && 'ghc810' || matrix.ghc == '9.6.6' && 'ghc96' }} |