Try out new GHA

.github/workflows/documentation.yaml

@@ -1,62 +1,116 @@
-name: docs
+name: Build and deploy
 
 on:
   push:
     branches: ["main"]
   pull_request:
     branches: ["main"]
 
+  # Re-run every Tuesday at 6AM
+  # schedule:
+  #   - cron: "0 6 * * 2"
+
+  # Re-run on demand:
+  workflow_dispatch:
+
 jobs:
 
-  mkdocs-link-check:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-    - name: mkdocs-link-check (soft)
-      uses: byrnereese/github-action-mkdocs-link-check@1.0
-      continue-on-error: true
-      with:
-          recurse: 'yes'
-          verbose-mode: 'yes'
-
-  docs:
-    name: "Deploy docs"
-    runs-on: ubuntu-22.04
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+  build-and-deploy:
+
+    runs-on: ubuntu-24.04
 
     steps:
+
       - uses: actions/checkout@v4
+        with:
+          path: MAIN
 
+      - name: Set fractal-web reference
+        run: |
+          FRACTAL_WEB_REFERENCE=$(cat MAIN/fractal-web-reference.txt)
+          echo "FRACTAL_WEB_REFERENCE=$FRACTAL_WEB_REFERENCE" >> $GITHUB_ENV
+
+      - run: echo ${{ env.FRACTAL_WEB_REFERENCE }}
+
+      - uses: actions/checkout@v4
+        with:
+          repository: fractal-analytics-platform/fractal-web
+          ref: ${{ env.FRACTAL_WEB_REFERENCE }}
+          path: WEB
+          sparse-checkout: |
+            components
+            tasks-list
+
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           cache: pip
 
-      - name: Install requirements
-        run: python -m pip install -r requirements.txt
+      # MKDocs build
 
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REQUIREMENTS: docs/doc-requirements.txt
+      - name: Install dependencies
+        run: python -m pip install -r MAIN/requirements.txt
 
+      - name: MKDocs build
+        run: mkdocs build --config-file MAIN/mkdocs.yml --strict --site-dir ./site
 
-  docs-build:
-    name: "Test docs build"
-    runs-on: ubuntu-22.04
-    if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }}
+      - run: mv MAIN/site ./site
 
-    steps:
-      - uses: actions/checkout@v4
+      # Retrieve remote task-list data
 
-      - uses: actions/setup-python@v5
+      - name: Install requirements
+        run: python3 -m pip install -r MAIN/tasks_data_retrieval/requirements.txt
+
+      - name: Fetch tasks data
+        run: python3 -u MAIN/tasks_data_retrieval/create_tasks_data.py
+
+      - run: cat MAIN/tasks_data_retrieval/tasks.json
+
+      - uses: actions/setup-node@v4
         with:
-          python-version: '3.10'
-          cache: pip
+          node-version: 20
+          cache: npm
+          cache-dependency-path: WEB/package-lock.json
 
-      - name: Install requirements
-        run: python -m pip install -r requirements.txt
+      - name: Install main fractal-web dependencies
+        run: |
+          cd WEB
+          npm install
 
-      - name: MKDocs build
-        run: mkdocs build --config-file mkdocs.yml
+      - name: Install components dependencies
+        run: |
+          cd WEB/components
+          npm install
+
+      - name: Install tasks-list dependencies
+        run: |
+          cd WEB/tasks-list
+          npm install
+
+      - name: Move tasks.json file to tasks-list/src
+        run: mv MAIN/tasks_data_retrieval/tasks.json WEB/tasks-list/src/
+
+      - name: Build tasks-list page
+        run: |
+          cd WEB/tasks-list
+          npm run build
+
+      - name: Move tasks-list built files in docs site
+        run: mv WEB/tasks-list/build/ site/task-table
+
+      - name: Set last-updated timestamp
+        run: |
+          CURRENT_DATE=$(date +"%Y-%m-%d %H:%M %Z")
+          echo "$CURRENT_DATE"
+          sed -i'.bak1' "s/LASTUPDATEDPLACEHOLDER/$CURRENT_DATE/" site/available_tasks/index.html
+          sed -i'.bak2' "s/FRACTALWEBREFERENCEPLACEHOLDER/${{ env.FRACTAL_WEB_REFERENCE }}/" site/available_tasks/index.html
+          rm site/available_tasks/index.html.bak1 site/available_tasks/index.html.bak2
+
+      - run: ls -lh site/*
+
+      - name: Deploy docs
+        if: ${{ ( github.event_name == 'push' || github.event_name == 'workflow_dispatch' ) && github.event.ref == 'refs/heads/main' }}
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

docs/available_tasks.md

@@ -0,0 +1,27 @@
+---
+hide:
+  - navigation
+  - toc
+  - title
+---
+
+<style>
+  .md-typeset h1,
+  .md-content__button {
+    display: none;
+  }
+</style>
+
+<style>
+.tasks-iframe{
+    width: 100%;
+    height: 850px;
+    border: 0;
+}
+</style>
+
+<iframe src="../task-table/" class="tasks-iframe">
+</iframe>
+
+
+(last updated: LASTUPDATEDPLACEHOLDER; `fractal-web` version: FRACTALWEBREFERENCEPLACEHOLDER)

docs/index.md

@@ -2,6 +2,14 @@
 layout: default
 ---
 
+<style>
+  .md-typeset h1,
+  .md-content__button {
+    display: none;
+  }
+</style>
+
+
 Fractal is a framework developed at the [BioVisionCenter](https://www.biovisioncenter.uzh.ch/en.html) to process bioimaging data at scale in the OME-Zarr format and prepare the images for interactive visualization.
 
 ![Fractal overview](https://github.com/user-attachments/assets/666c8797-2594-4b8e-b1d2-b43fca66d1df)

fractal-web-reference.txt

@@ -0,0 +1 @@
+v1.13.0

mkdocs.yml

@@ -46,6 +46,7 @@ nav:
   - Fractal V2 Changes: version_2/
   - Build Your Own Fractal Task: build_your_own_fractal_task.md
   - Deploy Fractal Server & Web: run_fractal.md
+  - Available tasks: available_tasks.md
 
 # Include some page, without including them in the ToC
 # not_in_nav: something.md

tasks_data_retrieval/.gitignore

@@ -0,0 +1,2 @@
+tasks.json
+venv

tasks/data_retrieval/create_tasks_data.py → tasks_data_retrieval/create_tasks_data.py

@@ -196,6 +196,7 @@ def _get_task_type(
     "input_types",
     "output_types",
     "docs_link",
+    "docs_info",
 ]
 COLUMN_DEFAULTS = {
     "input_types": {},
@@ -253,7 +254,7 @@ def _get_task_type(
     print(f"END processing {source=} - version={pkg_version}' - added {ntasks} tasks - elapsed {t_end-t_start:.3f} s.")
     print()
 
-output_file = Path(__file__).parent / "tasks_data.json"
+output_file = Path(__file__).parent / "tasks.json"
 with output_file.open("w") as f:
     json.dump(TASK_GROUPS, f, indent=2)
 

tasks/data_retrieval/sources.txt → tasks_data_retrieval/sources.txt

@@ -1,14 +1,10 @@
-# PyPI
 https://pypi.org/project/fractal-tasks-core/
 https://pypi.org/project/fractal-faim-ipa
 https://pypi.org/project/fractal-lif-converters
 https://pypi.org/project/operetta-compose
+https://github.com/fractal-analytics-platform/fractal-helper-tasks
 
-# GitHub releases with wheels
-https://github.com/fractal-analytics-platform/fractal-lif-converters/
 
-
-# https://github.com/fractal-analytics-platform/fractal-helper-tasks
 # https://github.com/fmi-basel/gliberal-scMultipleX
 # https://github.com/Apricot-Therapeutics/APx_fractal_task_collection
 # https://github.com/fractal-analytics-platform/fractal-plantseg-tasks

tools/full_local_build.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+set -e
+
+date
+
+FRACTAL_WEB_REFERENCE=$(cat fractal-web-reference.txt)
+
+CURRENT_DIR=$(pwd)
+WEBDIR="/tmp/WEB"
+VENVDIR="/tmp/venv-for-landing-page"
+
+python3 -m venv "$VENVDIR"
+source "$VENVDIR/bin/activate"
+
+# MKDocs
+python3 -m pip install -r requirements.txt
+mkdocs build --config-file mkdocs.yml --strict --site-dir ./site
+
+# Parse packages
+python3 -m pip install -r tasks_data_retrieval/requirements.txt
+python3 -u tasks_data_retrieval/create_tasks_data.py
+ls -lh tasks_data_retrieval/tasks.json
+
+# Build
+git clone git@github.com:fractal-analytics-platform/fractal-web "$WEBDIR"
+cd "$WEBDIR"
+git checkout "$FRACTAL_WEB_REFERENCE"
+cd "$WEBDIR"
+npm install
+cd "$WEBDIR/components/"
+npm install
+cd "$WEBDIR/tasks-list"
+npm install
+cp "$CURRENT_DIR/tasks_data_retrieval/tasks.json" ./src/
+npm run build
+cp -r build "$CURRENT_DIR/site/task-table"
+
+CURRENT_DATE=$(date +"%Y-%m-%d %H:%M %Z")
+sed -i'.bak1' "s/LASTUPDATEDPLACEHOLDER/$CURRENT_DATE/" "$CURRENT_DIR/site/available_tasks/index.html"
+sed -i'.bak2' "s/FRACTALWEBREFERENCEPLACEHOLDER/$FRACTAL_WEB_REFERENCE/" "$CURRENT_DIR/site/available_tasks/index.html"
+rm "$CURRENT_DIR/site/available_tasks/index.html.bak1"
+rm "$CURRENT_DIR/site/available_tasks/index.html.bak2"
+
+
+deactivate
+rm -r "$VENVDIR"
+rm -rf "$WEBDIR"
+
+cd "$CURRENT_DIR/site"
+date
+python3 -m http.server