Add links checker

Author: fcollonval

.github/workflows/main.yml

@@ -67,7 +67,7 @@ jobs:
           node-version: "12.x"
       - name: Install Python
         if: steps.filter.outputs.extension == 'true'
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: "3.7"
           architecture: "x64"
@@ -88,9 +88,7 @@ jobs:
       - 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 jupyterlab
+          python -m pip install --upgrade pip jupyter_packaging~=0.7.9 jupyterlab~=3.0
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -112,9 +110,7 @@ jobs:
         run: |
           cd ${EXAMPLE_FOLDER}
           pip install -e .
-          jupyter labextension list 1>labextensions 2>&1
-          cat labextensions
-          cat labextensions | grep -i "@jupyterlab-examples/*.*OK"
+          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/*.*OK"
           python -m jupyterlab.browser_check
           pip uninstall -y $(python setup.py --name)
         env:
@@ -161,7 +157,7 @@ jobs:
         shell: bash
       - name: Install Python
         if: steps.filter.outputs.extension == 'true'
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: "3.7"
           architecture: "x64"
@@ -182,9 +178,7 @@ jobs:
       - 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 jupyterlab
+          python -m pip install --upgrade pip jupyter_packaging~=0.7.9 jupyterlab~=3.0
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -206,10 +200,8 @@ jobs:
       - name: Check extension as dev
         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"
+          jupyter server extension list 2>&1 | grep -ie "jlab_ext_example.*OK"
+          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/server-extension.*OK"
       - name: Clean extension installation
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -222,14 +214,11 @@ jobs:
         run: |
           cd advanced/server-extension
           pip install -e .
-          jupyter server extension enable --py jlab_ext_example
       - name: Check extension as dev
         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"
+          jupyter server extension list 2>&1 | grep -ie "jlab_ext_example.*OK"
+          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/server-extension.*OK"
           python -m jupyterlab.browser_check
 
   build_all:
@@ -255,7 +244,7 @@ jobs:
         with:
           node-version: "12.x"
       - name: Install Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: "3.7"
           architecture: "x64"
@@ -272,11 +261,12 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
-        run: python -m pip install jupyterlab
+        run: python -m pip install jupyterlab~=3.0 pytest pytest-check-links
       - name: Bootstrap the jlpm deps
         run: jlpm
       - name: Build all the extensions
         run: |
+          pytest --check-links
           jlpm build-ext
           jlpm lint:check
           jlpm install-ext

README.md

@@ -77,7 +77,7 @@ You can expect from each example:
 - The list of used JupyterLab API and Extension Points.
 - Explanations of the internal working, illustrated with code snippets.
 
-We have structured the examples based on the [extension points](https://jupyterlab.readthedocs.io/en/stable/developer/extension_points.html). Browse the previews below or skip them and [jump directly to the sections for developers](#prerequisites).
+We have structured the examples based on the [extension points](https://jupyterlab.readthedocs.io/en/stable/extension/extension_points.html). Browse the previews below or skip them and [jump directly to the sections for developers](#prerequisites).
 
 You are welcome to open any [issue](https://github.com/jupyterlab/extension-examples/issues) or [pull request](https://github.com/jupyterlab/extension-examples/pulls).
 
@@ -255,16 +255,14 @@ jlpm clean-ext
 Go to the example directory you want to install, e.g. `cd ./basics/hello-world`, and run the following commands:
 
 ```bash
-jlpm install
-jlpm run build
-jupyter labextension install .
+pip install -e .
+jupyter labextension develop . --overwrite
 ```
 
-Rebuild the JupyterLab application:
+Rebuild the extension:
 
 ```bash
 jlpm run build
-jupyter lab build
 ```
 
 You can now start JupyterLab and check if your extension is working fine:
@@ -296,11 +294,11 @@ We are using [embedme](https://github.com/zakhenry/embedme) to embed code snippe
 
 ## Install a Published Extension
 
-Once your extension is published (outside of this scope), you can install it
+Once your extension is published on [pypi.org](https://pypi.org/) (outside of this scope), you can install it
 with the following command:
 
 ```bash
-jupyter labextension install <published_extension>
+pip install <published_extension>
 ```
 
 ## About JupyterLab
@@ -313,9 +311,9 @@ of libraries from different languages.
 
 Complementary to these examples, you can rely on the official JupyterLab documentation.
 
-- [Extension Developer Guide](https://jupyterlab.readthedocs.io/en/stable/developer/extension_dev.html)
-- [Common Extension Points](https://jupyterlab.readthedocs.io/en/stable/developer/extension_points.html)
-- [Astronomy Picture of the Day JupyterLab Extension](https://jupyterLab.readthedocs.io/en/stable/developer/extension_tutorial.html)
+- [Extension Developer Guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html)
+- [Common Extension Points](https://jupyterlab.readthedocs.io/en/stable/extension/extension_points.html)
+- [Astronomy Picture of the Day JupyterLab Extension](https://jupyterLab.readthedocs.io/en/stable/extension/extension_tutorial.html)
 
 ## Credits
 

command-palette/README.md

@@ -72,5 +72,5 @@ appear in the web browser console after clicking on the command in the palette.
 
 A command can be triggered by other UI elements:
 
-- Add the command to a [menu](../../main-menu/README.md)
-- Add the command to the [launcher](../../launcher/README.md)
+- Add the command to a [menu](../main-menu/README.md)
+- Add the command to the [launcher](../launcher/README.md)

environment.yml

@@ -5,5 +5,7 @@ dependencies:
   - jupyter-packaging>=0.7.9,<0.8.0
   - jupyterlab=3
   - nodejs
+  - pytest
+  - pytest-check-links
   - python=3
   - yarn

main-menu/README.md

@@ -9,7 +9,7 @@ the notion of _Commands_ as explained in the [commands example](../commands/READ
 One of the possibilities offered to the user to trigger that command is to call it from
 a menu item.
 
-Adding new menu item works in a similar way to the [command palette](../../command-palette/README.md).
+Adding new menu item works in a similar way to the [command palette](../command-palette/README.md).
 The `IMainMenu` interface can be requested as a new argument to the `activate`
 function, but first it has to be imported. And the class `Menu` to create new
 menu needs also to be imported but from the Lumino library:

widget-tracker/widgets/README.md

@@ -4,7 +4,7 @@
 
 In this example you will learn how to add a new tab to JupyterLab.
 
-Visible elements such as tabs and notebooks are represented by widgets in the [Lumino](http://jupyterlab.github.io/lumino/api/widgets/globals.html)
+Visible elements such as tabs and notebooks are represented by widgets in the [Lumino](https://jupyterlab.github.io/lumino/widgets/index.html)
 library that is the basis of the JupyterLab application.
 
 It is the fundamental brick of any visual component in the JupyterLab interface.
@@ -28,7 +28,7 @@ jlpm add @lumino/widgets
 ```
 
 A Widget can be added to the main area through the
-[JupyterLab Shell](http://jupyterlab.github.io/jupyterlab/application/classes/labshell.html).
+[JupyterLab Shell](https://jupyterlab.github.io/jupyterlab/classes/_application_src_index_.labshell.html).
 
 Inside of the `activate` function, you can obtain it through the `shell` attribute
 of the `app` object: