Add initial CI setup #20
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: CI | |
| # Trigger the workflow on all pull requests and pushes/merges to main branch | |
| on: | |
| pull_request: | |
| push: | |
| branches: [main] | |
| concurrency: | |
| group: ${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| setup-nix: | |
| name: Setup Nix | |
| runs-on: ubuntu-latest | |
| env: | |
| NIXPKGS_ALLOW_BROKEN: 1 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install Nix | |
| uses: cachix/install-nix-action@v22 | |
| with: | |
| nix-path: nixpkgs=channel:nixos-unstable | |
| - name: Cache nix | |
| uses: DeterminateSystems/magic-nix-cache-action@v2 | |
| - name: Build the nix environment | |
| run: nix-build | |
| cabal: | |
| name: Cabal tests - ghc ${{ matrix.ghc }} / clash ${{ matrix.clash }} | |
| runs-on: ${{ matrix.os }} | |
| needs: setup-nix | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| clash: | |
| - "1.8.1" | |
| cabal: | |
| - "3.10" | |
| ghc: | |
| - "9.6.4" | |
| env: | |
| clash_version: ${{ matrix.clash }} | |
| NIXPKGS_ALLOW_BROKEN: 1 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Haskell | |
| uses: haskell-actions/setup@v2 | |
| id: setup-haskell-cabal | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| - name: Use CI specific settings | |
| run: | | |
| cp .ci/cabal.project.local . | |
| - name: Setup CI | |
| run: | | |
| nix-shell --run "cabal v2-freeze" | |
| mv cabal.project.freeze frozen | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.setup-haskell-cabal.outputs.cabal-store }} | |
| key: ${{ runner.os }}-ghc-${{ matrix.ghc }}-${{ matrix.clash }}-${{ hashFiles('frozen') }} | |
| restore-keys: | | |
| ${{ runner.os }}-ghc-${{ matrix.ghc }}-${{ matrix.clash }}-${{ hashFiles('frozen') }} | |
| ${{ runner.os }}-ghc-${{ matrix.ghc }}-${{ matrix.clash }}- | |
| ${{ runner.os }}-ghc-${{ matrix.ghc }}- | |
| - name: Unit Tests | |
| run: | | |
| nix-shell --run ".ci/test_cabal.sh" | |
| - name: Testsuite (VHDL) | |
| run: | | |
| nix-shell --run "cabal v2-run cores-testsuite -- --hide-successes -p .VHDL --no-vivado" | |
| - name: Testsuite (Verilog) | |
| run: | | |
| nix-shell --run "cabal v2-run cores-testsuite -- --hide-successes -p .Verilog --no-vivado" | |
| - name: Testsuite (SystemVerilog) | |
| run: | | |
| nix-shell --run "cabal v2-run cores-testsuite -- --hide-successes -p .SystemVerilog --no-modelsim --no-vivado" | |
| documentation: | |
| name: Haddock Documentation - ghc ${{ matrix.ghc }} / clash ${{ matrix.clash }} | |
| needs: setup-nix | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| clash: | |
| - "1.8.1" | |
| cabal: | |
| - "3.10" | |
| ghc: | |
| - "9.6.4" | |
| env: | |
| clash_version: ${{ matrix.clash }} | |
| NIXPKGS_ALLOW_BROKEN: 1 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Haskell | |
| uses: haskell-actions/setup@v2 | |
| id: setup-haskell-cabal | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| - name: Use CI specific settings | |
| run: | | |
| cp .ci/cabal.project.local . | |
| - name: Build | |
| run: | | |
| nix-shell --run ".ci/build_docs.sh" | |
| linting: | |
| name: Source code linting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Whitespace | |
| run: | | |
| .ci/test_whitespace.sh | |