Fix CI (#1254)

* ci: update micromamba action to use @main and new configuration

* ci: update Python version to 3.11

* ci: use create-args for Python version instead of environment file

* ci: install build from pip instead of conda

* ci: update actions/upload-artifact from v2 to v4

* ci: exclude examples from ruff checks and ignore F403 for notebooks

* ci: add sphinx.configuration to pyproject.toml

* ci: fix sphinx.configuration to only include source directory

* ci: configure ruff via command line options in workflow

* ci: add Sphinx configuration to .readthedocs.yaml

* ci: fix docs build environment dependencies

* ci: remove invalid --extend-include argument from ruff command

* ci: exclude ui-tests directory from ruff checks

* refactor: replace geopandas.read_file with geodatasets.read_file in notebooks

* fix: update build environment to include jupyter_sphinx

* fix: update geopandas import in geodata.rst

* chore: remove docs building from CI as it's handled by readthedocs

* Bump galata version

* try using geopandas to read file instead in rst

* fix syntax error in notebooks

* fix syntax error in more notebooks

* shall load

* Esri.DeLorme no longer available

* don't fail on warning?

* Manually update snapshots

---------

Co-authored-by: Maarten A. Breddels <[email protected]>

Author: arjxn-py

.github/workflows/main.yml

@@ -20,18 +20,18 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: [3.8]
+        python-version: [3.11]
 
     steps:
       - uses: actions/checkout@v2
 
       - name: Setup conda
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@main
         with:
           environment-file: environment-dev.yml
-          condarc: |
-            dependencies:
-              - python==${{ matrix.python-version }}
+          init-shell: bash
+          cache-environment: true
+          create-args: python=${{ matrix.python-version }}
 
       - name: Install ipyleaflet
         run: pip install python/jupyter_leaflet python/ipyleaflet --no-deps
@@ -45,7 +45,7 @@ jobs:
           test -f $CONDA_PREFIX/share/jupyter/labextensions/jupyter-leaflet/package.json
 
       - name: Python Linters
-        run: ruff check --output-format=github .
+        run: ruff check --output-format=github --exclude "examples,ui-tests" --ignore "E501,E731,F403" .
 
       - name: JS Linters
         run: |

.github/workflows/ui-tests.yml

@@ -37,17 +37,33 @@ jobs:
         run: npx playwright test
         working-directory: ui-tests
 
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: test-results
+          retention-days: 5
+
+      - name: Upload screenshots
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshots
+          path: screenshots
+          retention-days: 5
+
       - name: Upload Playwright Test assets
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ipyleaflet-test-assets
           path: |
             ui-tests/test-results
 
       - name: Upload Playwright Test report
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ipyleaflet-test-report
           path: |

.readthedocs.yaml

@@ -7,3 +7,7 @@ build:
 
 conda:
   environment: docs/build-environment.yml
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false

docs/build-environment.yml

@@ -4,11 +4,11 @@ channels:
   - conda-forge
 
 dependencies:
+  - pip
   - yarn~=3.0
   - jupyterlab~=4.0
   - jupyter-packaging~=0.12
   - jupyter-sphinx
-  - build
   - scipy
   - netcdf4
   - geopandas
@@ -18,6 +18,8 @@ dependencies:
   - pydata-sphinx-theme
   - jupyterlite-sphinx
   - jupyterlite-xeus-python >=0.9.2,<0.10
+  - geodatasets
   - pip:
+      - build
       - ../python/jupyter_leaflet
       - ../python/ipyleaflet

docs/layers/geodata.rst

@@ -12,9 +12,10 @@ Examples
 
     from ipyleaflet import Map, GeoData, basemaps, LayersControl
     import geopandas
+    import geodatasets
     import json
 
-    countries = geopandas.read_file(geopandas.datasets.get_path('naturalearth_lowres'))
+    countries = geopandas.read_file(geodatasets.get_path('naturalearth_land'))
 
     m = Map(center=(52.3,8.0), zoom = 3, basemap= basemaps.Esri.WorldTopoMap)
 

docs/map_and_basemaps/basemaps.rst

@@ -46,11 +46,6 @@ These basemaps are coming from the `xyzservices <https://xyzservices.readthedocs
     Map(basemap=basemaps.Esri.WorldStreetMap, center=center, zoom=zoom)
 
 
-.. jupyter-execute::
-
-    Map(basemap=basemaps.Esri.DeLorme, center=center, zoom=zoom)
-
-
 .. jupyter-execute::
 
     Map(basemap=basemaps.Esri.WorldTopoMap, center=center, zoom=zoom)

environment-dev.yml

@@ -3,7 +3,6 @@ channels:
   - conda-forge
 dependencies:
   - pip
-  - build
   - wheel
   - jupyterlab~=4.0
   - jupyter-packaging~=0.12
@@ -14,3 +13,5 @@ dependencies:
   - pandas
   - yarn~=3.0
   - ruff
+  - pip:
+    - build

examples/CanvasRenderer.ipynb

@@ -9,6 +9,7 @@
    "source": [
     "from ipyleaflet import Map, GeoData\n",
     "import geopandas\n",
+    "import geodatasets\n",
     "import numpy as np\n",
     "import shapely"
    ]

examples/GPX.ipynb

@@ -16,7 +16,8 @@
    "outputs": [],
    "source": [
     "from ipyleaflet import Map, GeoData\n",
-    "import geopandas as gpd\n",
+    "import geopandas\n",
+    "import geodatasets as gpd\n",
     "import fiona"
    ]
   },

examples/GeoData.ipynb

@@ -15,6 +15,7 @@
    "source": [
     "import ipyleaflet as ipy\n",
     "import geopandas\n",
+    "import geodatasets\n",
     "import json"
    ]
   },
@@ -33,9 +34,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "countries = geopandas.read_file(geopandas.datasets.get_path(\"naturalearth_lowres\"))\n",
-    "cities = geopandas.read_file(geopandas.datasets.get_path(\"naturalearth_cities\"))\n",
-    "rivers = geopandas.read_file(\n",
+    "countries = geodatasets.read_file(geopandas.datasets.get_path(\"naturalearth_lowres\"))\n",
+    "cities = geodatasets.read_file(geopandas.datasets.get_path(\"naturalearth_cities\"))\n",
+    "rivers = geodatasets.read_file(\n",
     "    \"https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/10m/physical/ne_10m_rivers_lake_centerlines.zip\"\n",
     ")"
    ]