Merge branch 'main' into hooks

Author: nakul-py

.github/workflows/build.yml

@@ -69,7 +69,7 @@ jobs:
           yarn build:packages
 
       - name: Upload extension packages
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: ${{ matrix.python-version == '3.12' && 'extension-artifacts' || format('extension-artifacts-{0}', matrix.python-version) }}
           path: |
@@ -121,7 +121,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/download-artifact@v5
+      - uses: actions/download-artifact@v6
         with:
           name: extension-artifacts
 
@@ -166,7 +166,7 @@ jobs:
             qgis
 
       - name: Download extension package
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: extension-artifacts
 
@@ -192,7 +192,7 @@ jobs:
       - name: Upload Playwright Test report
         id: upload-galata-artifact
         if: always()
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: jupytergis-playwright-tests
           path: |
@@ -239,7 +239,7 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
         with:
-          ignore_links: 'lite/'
+          ignore_links: 'lite/ https://www.npmjs.com.* ^/.*'
 
   build-lite:
     name: Build JupyterLite artifacts
@@ -263,7 +263,7 @@ jobs:
             jupyter_server
 
       - name: Download extension package
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: extension-artifacts
 
@@ -290,7 +290,7 @@ jobs:
           jupyter lite build --contents content --output-dir dist
 
       - name: Upload Lite artifacts
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: lite-artifacts
           path: ./lite/dist
@@ -318,7 +318,7 @@ jobs:
             jupyterlab
 
       - name: Download extension package
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: lite-artifacts
           path: dist
@@ -350,7 +350,7 @@ jobs:
       - name: Upload Playwright Test report
         id: upload-galata-artifact
         if: always()
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: jupytergis-lite-playwright-tests
           path: |

.github/workflows/check-release.yml

@@ -27,7 +27,7 @@ jobs:
           version_spec: next
 
       - name: Upload Distributions
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: jupytergis-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ exclude: '.*\.jgis$'
 repos:
   # Autoformat and linting, misc. details
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: forbid-new-submodules
       - id: end-of-file-fixer
@@ -28,7 +28,7 @@ repos:
 
   # Autoformat: Python code
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.2
+    rev: v0.13.3
     hooks:
       - id: ruff
         args: ['--fix']

docs/build-on-change.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# NOTE: Requires `inotify-tools`. e.g. `apt install inotify-tools`.
+# TODO: MacOS support?
+set -euo pipefail
+
+THIS_DIR="$( cd "$(dirname "$0")"; pwd -P )"
+cd "${THIS_DIR}"
+HTML_PATH="./_build/html/index.html"
+
+${THIS_DIR}/clean.sh
+
+set +e
+${THIS_DIR}/build.sh
+xdg-open "${HTML_PATH}"
+set -e
+
+while inotifywait -e delete -e create -e close_write -r ${THIS_DIR}; do
+    ${THIS_DIR}/clean.sh
+
+    set +e
+    ${THIS_DIR}/build.sh
+    set -e
+done

docs/build.sh

@@ -1,9 +1,10 @@
 #!/usr/bin/env bash
+set -euo pipefail
 
 THIS_DIR="$( cd "$(dirname "$0")"; pwd -P )"
 
 # Build can fail if certain artifacts exist here:
-rm -rf "${THIS_DIR}/_build"
+${THIS_DIR}/clean.sh
 
 python -m sphinx \
     --nitpicky --show-traceback \

docs/clean.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+THIS_DIR="$( cd "$(dirname "$0")"; pwd -P )"
+rm -rf "${THIS_DIR}/_build"

docs/contributor_guide/development_setup.md

@@ -24,6 +24,11 @@ cd jupytergis
 
 ```````{tabs}
 ``````{group-tab} Micromamba (Recommended)
+```{note}
+Micromamba is a lightweight package manager compatible with conda environments.
+It is recommended for setting up the JupyterGIS development environment. If you don’t have it installed, please follow the official documentation: [Micromamba Installation Guide](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)
+```
+
 ```bash
 # Create a virtual environment
 

docs/contributor_guide/how-tos/build-docs-locally.md

@@ -7,7 +7,7 @@ below, but they will not be as fast.
 
 ## 0. Build JupyterGIS JavaScript packages
 
-Follow the [development environment setup instructions](../development_setup.md) through running `jlpm run build` from the **root of the repo**.
+Follow the [development environment setup instructions](/contributor_guide/development_setup.md) through running `jlpm run build` from the **root of the repo**.
 
 :::{important}
 Navigate to the `docs/` directory before starting any of the following steps!

docs/contributor_guide/how-tos/code_quality.md

@@ -1,7 +1,7 @@
 # Check code quality
 
 ```{seealso}
-Complete [dev install](../development_setup) instructions before continuing.
+Complete [dev install](/contributor_guide/development_setup) instructions before continuing.
 ```
 
 We have several tools configured for checking code quality:

docs/contributor_guide/index.md

@@ -2,6 +2,11 @@
 
 We're thrilled you're ready to contribute to JupyterGIS!
 
+This documentation will help you get started with the technical aspects of contribution
+to this project.
+To learn more about the social aspects (meeting notes, policies, roles), please view the
+[GeoJupyter team compass](https://compass.geojupyter.org/).
+
 To chat with other contributors, please
 [join us on Zulip](https://jupyter.zulipchat.com/#narrow/channel/471314-geojupyter)!