build.yml

name: Build

on:
  push:
    branches: main
  pull_request:
    branches: '*'

jobs:
  build:
    name: Build jupytergis
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v2
        with:
          environment-name: gis
          create-args: >-
            python=3.9
            jupyterlab=4
            yarn=3
            pillow
            mercantile
            xyzservices

      - name: Setup pip cache
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: pip-3.9-${{ hashFiles('package.json') }}
          restore-keys: |
            pip-3.9-
            pip-

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - name: Setup yarn cache
        uses: actions/cache@v4
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: yarn-${{ hashFiles('yarn.lock') }}
          restore-keys: |
            yarn-

      - name: Build the extension
        shell: bash -l {0}
        run: |
          set -eux
          yarn install
          yarn dev
          jupyter labextension list 2>&1 | grep -ie "jupytergis-core.*OK"
          jupyter labextension list 2>&1 | grep -ie "jupytergis-lab.*OK"

      - name: Package the extension
        shell: bash -l {0}
        run: |
          set -eux
          pip install hatch
          yarn build:packages

      - name: Upload extension packages
        uses: actions/upload-artifact@v4
        with:
          name: extension-artifacts
          path: |
            python/jupytergis_core/dist/jupytergis*
            python/jupytergis_lab/dist/jupytergis*
            python/jupytergis_qgis/dist/jupytergis*
          if-no-files-found: error

  python_tests:
    runs-on: ubuntu-latest

    steps:
      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v2
        with:
          environment-name: gis
          create-args: >-
            python=3.9
            jupyterlab=4
            yarn=3
            qgis

      - name: Checkout
        uses: actions/checkout@v4

      - name: Install
        shell: bash -l {0}
        run: python scripts/dev-install.py

      - name: Install test packages
        shell: bash -l {0}
        run: pip install pytest dirty-equals

      - name: Run tests
        shell: bash -l {0}
        run: pytest --color=yes -v python/jupytergis_qgis/jupytergis_qgis/tests

      - name: Run Python API tests
        shell: bash -l {0}
        run: pytest --color=yes -v python/jupytergis_lab/

  test_isolated:
    needs: build
    runs-on: ubuntu-latest

    steps:
      - uses: actions/download-artifact@v4
        with:
          name: extension-artifacts

      - name: Install and Test
        shell: bash -l {0}
        run: |
          set -eux
          # Remove NodeJS, twice to take care of system and locally installed node versions.
          sudo rm -rf $(which node)
          sudo rm -rf $(which node)

          cp ./jupytergis_core/dist/jupytergis*.whl ./jupytergis_lab/dist/jupytergis*.whl ./jupytergis_qgis/dist/jupytergis*.whl .
          python -m pip install jupytergis*.whl

          jupyter labextension list
          jupyter labextension list 2>&1 | grep -ie "jupytergis.*OK"
          # jupyterlab.browser_check will fail due to the core extension jupyterlab_pygments.
          # It does not support lab v4.0.0
          #python -m jupyterlab.browser_check --no-chrome-test

  integration-tests:
    name: Integration tests
    needs: build
    runs-on: ubuntu-latest

    env:
      PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v2
        with:
          micromamba-version: '1.5.5-0'
          environment-name: gis
          create-args: >-
            python=3.9
            jupyterlab=4
            ipywidgets
            qgis

      - name: Download extension package
        uses: actions/download-artifact@v4
        with:
          name: extension-artifacts

      - name: Install the extension
        shell: bash -l {0}
        run: |
          set -eux
          cp ./jupytergis_core/dist/jupytergis*.whl ./jupytergis_lab/dist/jupytergis*.whl ./jupytergis_qgis/dist/jupytergis*.whl .
          python -m pip install jupytergis*.whl

      - name: Install dependencies
        shell: bash -l {0}
        working-directory: ui-tests
        env:
          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
        run: jlpm install

      - name: Set up browser cache
        uses: actions/cache@v4
        with:
          path: |
            ${{ github.workspace }}/pw-browsers
          key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}

      - name: Install browser
        shell: bash -l {0}
        run: npx playwright install chromium
        working-directory: ui-tests

      - name: Execute integration tests
        shell: bash -l {0}
        working-directory: ui-tests
        run: npx playwright test --retries=2

      - name: Upload Playwright Test report
        id: upload-galata-artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: jupytergis-playwright-tests
          path: |
            ui-tests/test-results
            ui-tests/playwright-report

      - name: Save artifact data
        if: always()
        uses: trungleduc/appsharingspace-pr-comment/.github/actions/save-artifact-link@v2
        with:
          output_name: galata-apss
          artifact_link: 'https://github.com/${{ github.repository }}/actions/runs/${{github.run_id}}/artifacts/${{ steps.upload-galata-artifact.outputs.artifact-id }}'

  check_linting:
    name: Lint check
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v2
        with:
          environment-name: gis
          create-args: >-
            python=3.9
            jupyterlab=4
            yarn=3

      - name: Lint
        shell: bash -l {0}
        run: |
          jlpm install
          jlpm run eslint:check
          jlpm run prettier:check

  check_links:
    name: Check Links
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v4
      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
      - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
        with:
          ignore_links: 'lite/'

  build-docs-and-lite:
    name: Build docs with JupyterLite deployment
    needs: build
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v2
        with:
          micromamba-version: '1.5.5-0'
          environment-name: build-env
          create-args: >-
            python=3.10
            pip
            jupyterlite-core>=0.2.0,<0.3.0
            jupyterlite-xeus>=0.1.2,<0.2
            jupyterlite-sphinx
            sphinx
            sphinx-tabs
            pydata-sphinx-theme
            sphinx-autodoc-typehints

      - name: Download extension package
        uses: actions/download-artifact@v4
        with:
          name: extension-artifacts

      - name: Install the extension
        shell: bash -l {0}
        run: |
          set -eux
          cp ./jupytergis_core/dist/jupytergis*.whl ./jupytergis_lab/dist/jupytergis*.whl ./jupytergis_qgis/dist/jupytergis*.whl .
          python -m pip install jupytergis*.whl

      - name: Build the docs site
        shell: bash -l {0}
        working-directory: docs
        run: |
          set -eux
          sphinx-build . dist

      - name: Upload artifact
        id: upload-docs-artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/dist
          retention-days: 30

  deploy:
    needs: build-docs-and-lite
    if: github.ref == 'refs/heads/main'
    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4