Backport PR #121: Skip test if the extension is not touched

Author: fcollonval

.github/workflows/main.yml

@@ -33,7 +33,15 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+      - name: Path filter
+        id: filter
+        uses: dorny/paths-filter@v2
+        with:
+          filters: |
+            extension:
+              - '${{ matrix.example }}/**'
       - name: Cache lerna
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/cache@v2
         with:
           path: |
@@ -43,6 +51,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-lerna-
       - name: Check config files
+        if: steps.filter.outputs.extension == 'true'
         run: |
           diff basics/hello-world/tsconfig.json ${EXAMPLE_FOLDER}/tsconfig.json
           diff basics/hello-world/.eslintignore ${EXAMPLE_FOLDER}/.eslintignore
@@ -52,46 +61,54 @@ jobs:
           EXAMPLE_FOLDER: ${{ matrix.example }}
         shell: bash
       - name: Install node
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-node@v1
         with:
           node-version: "12.x"
       - name: Install Python
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-python@v1
         with:
           python-version: "3.7"
           architecture: "x64"
       - name: Get pip cache dir
+        if: steps.filter.outputs.extension == 'true'
         id: pip-cache
         run: |
           echo "::set-output name=dir::$(pip cache dir)"
         shell: bash
       - name: Cache pip
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/cache@v2
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip-${{ hashFiles('**/environment.yml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
+        if: steps.filter.outputs.extension == 'true'
         run: |
           python -m pip install --upgrade pip
           python -m pip install jupyter_packaging
           python -m pip install --pre jupyterlab
       - name: Install the NPM dependencies
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd ${EXAMPLE_FOLDER}
           jlpm
         env:
           EXAMPLE_FOLDER: ${{ matrix.example }}
         shell: bash
       - name: Lint the files
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd ${EXAMPLE_FOLDER}
           jlpm run eslint:check
         env:
           EXAMPLE_FOLDER: ${{ matrix.example }}
         shell: bash
       - name: Build and check by extension
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd ${EXAMPLE_FOLDER}
           pip install -e .
@@ -113,82 +130,101 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+      - name: Path filter
+        id: filter
+        uses: dorny/paths-filter@v2
+        with:
+          filters: |
+            extension:
+              - 'advanced/server-extension/**'
       - name: Cache lerna
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/cache@v2
         with:
           path: |
             node_modules
             */*/node_modules
-          key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json') }}
+          key: ${{ runner.os }}-lerna-${{ hashFiles('advanced/server-extension/package.json') }}
           restore-keys: |
             ${{ runner.os }}-lerna-
       - name: Install node
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-node@v1
         with:
           node-version: "12.x"
       - name: Check config files
+        if: steps.filter.outputs.extension == 'true'
         run: |
           diff basics/hello-world/tsconfig.json advanced/server-extension/tsconfig.json
           diff basics/hello-world/.eslintignore advanced/server-extension/.eslintignore
           diff basics/hello-world/.eslintrc.js advanced/server-extension/.eslintrc.js
         shell: bash
       - name: Install Python
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/setup-python@v1
         with:
           python-version: "3.7"
           architecture: "x64"
       - name: Get pip cache dir
+        if: steps.filter.outputs.extension == 'true'
         id: pip-cache
         run: |
           echo "::set-output name=dir::$(pip cache dir)"
         shell: bash
       - name: Cache pip
+        if: steps.filter.outputs.extension == 'true'
         uses: actions/cache@v2
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip-${{ hashFiles('**/environment.yml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
+        if: steps.filter.outputs.extension == 'true'
         run: |
           python -m pip install --upgrade pip
           python -m pip install jupyter_packaging
           python -m pip install --pre jupyterlab
       - name: Install the NPM dependencies
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd advanced/server-extension
           jlpm
       - name: Lint the files
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd advanced/server-extension
           jlpm run eslint:check
       - name: Build extension as user
+        if: steps.filter.outputs.extension == 'true'
         # Force the usage of the source distribution (good practice)
         run: |
           cd advanced/server-extension
           python setup.py sdist
           pip install jlab_ext_example --pre --find-links=dist --no-cache-dir
           python -m jupyterlab.browser_check
       - name: Check extension as dev
-        if: startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS')
+        if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
           jupyter server extension list 1>serverextensions 2>&1
           cat serverextensions | grep "jlab_ext_example.*OK"
           jupyter labextension list 1>labextensions 2>&1
           cat labextensions | grep "@jupyterlab-examples/server-extension.*OK"
       - name: Clean extension installation
+        if: steps.filter.outputs.extension == 'true'
         run: |
           pip uninstall -y jlab_ext_example
           jupyter lab clean
           jupyter server extension list
           jupyter labextension list
       - name: Build extension as dev
+        if: steps.filter.outputs.extension == 'true'
         run: |
           cd advanced/server-extension
           pip install -e .
           jupyter server extension enable --py jlab_ext_example
       - name: Check extension as dev
-        if: startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS')
+        if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
           jupyter server extension list 1>serverextensions 2>&1
           cat serverextensions | grep "jlab_ext_example.*OK"

basics/hello-world/README.md

@@ -2,7 +2,7 @@
 
 > Set up the development environment and print to the console.
 
-![hello-world example](./preview.png)
+![hello world example](./preview.png)
 
 - [The template folder structure](#the-template-folder-structure)
 - [A minimal extension that prints to the browser console](#a-minimal-extension-that-prints-to-the-browser-console)