From 143c2288c21fbd0aa347ed6e2676f63dbeb9af21 Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Jun 2023 18:57:35 +0200 Subject: [PATCH 1/2] Publish haddocks on gh-pages --- .github/workflows/github-page.yml | 72 +++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 .github/workflows/github-page.yml diff --git a/.github/workflows/github-page.yml b/.github/workflows/github-page.yml new file mode 100644 index 00000000..0cecba3b --- /dev/null +++ b/.github/workflows/github-page.yml @@ -0,0 +1,72 @@ +name: "Haddock documentation" + +on: + schedule: + - cron: '0 0 * * *' + workflow_dispatch: + +jobs: + haddocks: + name: "Haddocks" + + runs-on: ${{ matrix.os }} + + defaults: + run: + shell: bash + + strategy: + fail-fast: false + matrix: + ghc: ["9.4.4"] + os: [ubuntu-latest] + + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Checkout ouroboros-network repository + uses: actions/checkout@v3 + + # we need nix to later build the spec documents + - name: Install Nix + uses: cachix/install-nix-action@v20 + + - name: Install Haskell + uses: haskell/actions/setup@v2 + id: setup-haskell + with: + ghc-version: ${{ matrix.ghc }} + cabal-version: '3.10.1.0' + + - uses: actions/cache@v3 + name: Cache cabal store + with: + path: ${{ steps.setup-haskell.outputs.cabal-store }} + key: cache-haddock-${{ runner.os }}-${{ matrix.ghc }}-v1-${{ hashFiles('cabal-cache.cabal') }}-${{ github.sha }} + restore-keys: cache-haddock-${{ runner.os }}-${{ matrix.ghc }}-v1-${{ hashFiles('cabal-cache.cabal') }}- + + - name: Update Hackage index + run: cabal update + + - name: Build plan + run: cabal build --dry-run --enable-tests all + + - name: Build Haddock documentation 🔧 + run: | + cabal haddock-package --hackage all + + - name: Upload artifacts + uses: actions/upload-pages-artifact@v1 + with: + path: ./haddocks + + - name: Deploy 🚀 + id: deployment + uses: actions/deploy-pages@v2 + From d69c3ee2e90001b09b3a27a034fcab7f8b6a334d Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Fri, 2 Jun 2023 19:09:46 +0200 Subject: [PATCH 2/2] Updated haskell GitHub-Action --- .github/workflows/haskell.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml index 965dad83..5f1c0829 100644 --- a/.github/workflows/haskell.yml +++ b/.github/workflows/haskell.yml @@ -81,7 +81,7 @@ jobs: cabal --version echo "cabal-store=$(dirname $(cabal --help | tail -1 | tr -d ' '))\\store" >> $GITHUB_OUTPUT - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: "Configure cabal.project.local" run: | @@ -140,7 +140,7 @@ jobs: sudo apt-get -y install fd-find - name: "Setup Haskell" - uses: haskell/actions/setup@v1 + uses: haskell/actions/setup@v2 id: setup-haskell with: ghc-version: 9.2.5