doc: simplify and add docs #440
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 | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cabal | |
| dist-newstyle | |
| key: ${{ runner.os }}-build-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }} | |
| - uses: actions/checkout@v4 | |
| - uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: "8.6" | |
| cabal-version: "3.12" | |
| - name: Update the package index | |
| run: cabal update | |
| - name: Run tests | |
| run: cabal build | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cabal | |
| dist-newstyle | |
| key: ${{ runner.os }}-build-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }} | |
| - uses: actions/checkout@v4 | |
| - uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: "8.6" | |
| cabal-version: "3.12" | |
| - name: Update the package index | |
| run: cabal update | |
| - name: Run tests | |
| run: cabal test | |
| doctest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cabal | |
| dist-newstyle | |
| key: ${{ runner.os }}-doctest-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }} | |
| - uses: actions/checkout@v4 | |
| - uses: haskell-actions/setup@v2 | |
| with: | |
| ghc-version: "8.6" | |
| cabal-version: "3.12" | |
| - name: Install dependencies | |
| run: | | |
| cabal update | |
| cabal install doctest | |
| - name: Run doctests | |
| run: cabal repl --with-compiler=doctest |