Merge pull request #518 from fractal-analytics-platform/jschema-refactor

Refactor of JSchema component; moved Sandbox pages to docs

Author: zonia3000

.eslintignore

@@ -1,6 +1,9 @@
 .DS_Store
 node_modules
 /build
+/jschema/build
+/sandbox
+/site
 /.svelte-kit
 /package
 .env

.github/workflows/documentation.yaml

@@ -9,23 +9,8 @@ on:
 jobs:
 
   docs:
-    name: "Deploy docs"
+    name: "Generate docs"
     runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REQUIREMENTS: docs/doc-requirements.txt
-
-  docs-build:
-    name: "Test docs build"
-    runs-on: ubuntu-latest
-    if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }}
 
     steps:
       - uses: actions/checkout@v4
@@ -40,3 +25,34 @@ jobs:
 
       - name: MKDocs build
         run: mkdocs build --config-file mkdocs.yml --strict
+
+      - name: Set up node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install jschema dependencies
+        run: |
+          cd jschema
+          npm install
+
+      - name: Install sandbox dependencies
+        run: |
+          cd sandbox
+          npm install
+
+      - name: Build sandbox
+        run: |
+          cd sandbox
+          npm run build
+
+      - name: Move sandbox built files in docs site
+        run: mv sandbox/build/ site/sandbox
+
+      - name: Deploy docs
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.github/workflows/lint_and_build.yaml

@@ -29,6 +29,16 @@ jobs:
       - name: Install dependencies
         run: npm install
 
+      - name: Install jschema dependencies
+        run: |
+          cd jschema
+          npm install
+
+      - name: Run static code analysis on jschema module
+        run: |
+          cd jschema
+          npx eslint .
+
       - name: Run static code analysis
         run: npx eslint .
 

.github/workflows/unit_tests.yaml

@@ -29,6 +29,16 @@ jobs:
       - name: Install dependencies
         run: npm install
 
+      - name: Install jschema dependencies
+        run: |
+          cd jschema
+          npm install
+
+      - name: Run vitest tests on jschema module
+        run: |
+          cd jschema
+          npm run test
+
       - name: Run vitest tests
         run: npx vitest run
         env:

.gitignore

@@ -1,7 +1,9 @@
 .DS_Store
 node_modules
 /build
-/.svelte-kit
+/jschema/build
+/sandbox/build
+.svelte-kit
 /package
 .env.*local
 !.env.example

CHANGELOG.md

@@ -1,5 +1,12 @@
 *Note: Numbers like (\#123) point to closed Pull Requests on the fractal-web repository.*
 
+# Unreleased
+
+> Starting from this release the Sandbox pages are not included in fractal-web anymore, instead they are static pages published together with the documentation.
+
+* Moved JSON Schema components to a separated component (\#518);
+* Moved Sandbox pages to a separated component (\#518);
+
 # 1.2.0
 
 * Conditionally included V1 pages (\#514);