pages.yml

# workflow for building and deploying a smart-contracts docs site to GitHub Pages
name: Deploy Smart Contract docs with GitHub Pages dependencies preinstalled

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3
      - name: setup node
        uses: actions/setup-node@v3
        with:
          node-version: ">=18.12.0"
          cache: "npm"
      - name: install dependencies
        run: |
          corepack enable
          yarn install
      - name: Set up dummy env vars
        run: |
          echo "MAINNET_JSON_RPC_PROVIDER_URL=https://mainnet.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "GOERLI_JSON_RPC_PROVIDER_URL=https://goerli.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "ROPSTEN_JSON_RPC_PROVIDER_URL=https://ropsten.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "RINKEBY_JSON_RPC_PROVIDER_URL=https://rinkeby.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "KOVAN_JSON_RPC_PROVIDER_URL=https://kovan.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "PALM_MAINNET_JSON_RPC_PROVIDER_URL=https://palm-mainnet.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "PALM_TESTNET_JSON_RPC_PROVIDER_URL=https://palm-testnet.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "BASE_MAINNET_JSON_RPC_PROVIDER_URL=https://base-mainnet.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "ARBITRUM_MAINNET_JSON_RPC_PROVIDER_URL=https://arbitrum-mainnet.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
          echo "ARBITRUM_GOERLI_JSON_RPC_PROVIDER_URL=https://arbitrum-goerli.infura.io/v3/dummyApiKey" >> $GITHUB_ENV
      - name: build docs
        run: yarn workspace @artblocks/contracts run docgen
      - name: upload docs artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./packages/contracts/docs

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1