Upgrade dependencies and update server-extension install instructions (#175)

* Upgrade dependencies and update server-extension install instructions

* Update CI and server-extension pyproject.toml explanation

* Remove package-lock.json

* Upgrade eslint-plugin-jsdoc

* Don't use the preversion as 3.1 has been released

* run embedded

* playwright links

* Update line references

Co-authored-by: Frédéric Collonval <[email protected]>

Author: hbcarlos

.github/workflows/main.yml

@@ -95,7 +95,7 @@ jobs:
       - name: Install the Python dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
-          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.0
+          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.1
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: jlpm
@@ -196,7 +196,7 @@ jobs:
       - name: Install the Python dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
-          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.0
+          python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.1
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -306,7 +306,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install the Python dependencies
-        run: python -m pip install jupyter_packaging~=0.10 jupyterlab~=3.0 pytest pytest-check-links
+        run: python -m pip install jupyter_packaging~=0.10 jupyterlab~=3.1 pytest pytest-check-links
       - name: Bootstrap the jlpm deps
         run: jlpm
       - name: Build all the extensions

command-palette/RELEASE.md

@@ -0,0 +1,25 @@
+# Making a new release of jupyterlab_examples_command_palette
+
+The extension can be published to `PyPI` and `npm` using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser.
+
+Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
+
+Here is a summary of the steps to cut a new release:
+
+- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
+- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
+- Go to the Actions panel
+- Run the "Draft Changelog" workflow
+- Merge the Changelog PR
+- Run the "Draft Release" workflow
+- Run the "Publish Release" workflow
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

command-palette/package.json

@@ -48,15 +48,15 @@
     "watch:src": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "^3.0.11"
+    "@jupyterlab/application": "^3.1.0"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^3.0.0",
+    "@jupyterlab/builder": "^3.1.0",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
     "eslint": "^7.14.0",
     "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-jsdoc": "^34.0.0",
+    "eslint-plugin-jsdoc": "^36.0.0",
     "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-react": "^7.18.3",
     "npm-run-all": "^4.1.5",
@@ -73,4 +73,4 @@
     "outputDir": "jupyterlab_examples_command_palette/labextension"
   },
   "styleModule": "style/index.js"
-}
+}

command-palette/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.0"]
+requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.1"]
 build-backend = "jupyter_packaging.build_api"
 
 [tool.jupyter-packaging.options]

command-palette/setup.py

@@ -2,6 +2,7 @@
 jupyterlab_examples_command_palette setup
 """
 import json
+import sys
 from pathlib import Path
 
 import setuptools
@@ -23,7 +24,7 @@
 
 data_files_spec = [
     ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str("."), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
@@ -42,9 +43,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=setuptools.find_packages(),
-    install_requires=[
-        "jupyter_server>=1.6,<2"
-    ],
+    install_requires=[],
     zip_safe=False,
     include_package_data=True,
     python_requires=">=3.6",
@@ -71,10 +70,14 @@
     post_develop = npm_builder(
         build_cmd="install:extension", source_dir="src", build_dir=lab_path
     )
-    setup_args['cmdclass'] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
-    setup_args['data_files'] = get_data_files(data_files_spec)
+    setup_args["cmdclass"] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
+    setup_args["data_files"] = get_data_files(data_files_spec)
 except ImportError as e:
-    pass
+    import logging
+    logging.basicConfig(format="%(levelname)s: %(message)s")
+    logging.warning("Build tool `jupyter-packaging` is missing. Install it with pip or conda.")
+    if not ("--name" in sys.argv or "--version" in sys.argv):
+        raise e
 
 if __name__ == "__main__":
     setuptools.setup(**setup_args)

command-palette/ui-tests/README.md

@@ -39,7 +39,7 @@ jlpm run build:prod
 jupyter lab --ServerApp.token= --ServerApp.password=
 ```
 
-3. Execute in another console the [Playwright](https://playwright.dev/docs/test-intro) tests:
+3. Execute in another console the [Playwright](https://playwright.dev/docs/intro) tests:
 
 ```
 cd ui-tests

commands/RELEASE.md

@@ -0,0 +1,25 @@
+# Making a new release of jupyterlab_examples_commands
+
+The extension can be published to `PyPI` and `npm` using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser.
+
+Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
+
+Here is a summary of the steps to cut a new release:
+
+- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
+- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
+- Go to the Actions panel
+- Run the "Draft Changelog" workflow
+- Merge the Changelog PR
+- Run the "Draft Release" workflow
+- Run the "Publish Release" workflow
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

commands/package.json

@@ -48,15 +48,15 @@
     "watch:src": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "^3.0.11"
+    "@jupyterlab/application": "^3.1.0"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^3.0.0",
+    "@jupyterlab/builder": "^3.1.0",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
     "eslint": "^7.14.0",
     "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-jsdoc": "^34.0.0",
+    "eslint-plugin-jsdoc": "^36.0.0",
     "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-react": "^7.18.3",
     "npm-run-all": "^4.1.5",
@@ -73,4 +73,4 @@
     "outputDir": "jupyterlab_examples_commands/labextension"
   },
   "styleModule": "style/index.js"
-}
+}

commands/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.0"]
+requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.1"]
 build-backend = "jupyter_packaging.build_api"
 
 [tool.jupyter-packaging.options]

commands/setup.py

@@ -2,6 +2,7 @@
 jupyterlab_examples_commands setup
 """
 import json
+import sys
 from pathlib import Path
 
 import setuptools
@@ -23,7 +24,7 @@
 
 data_files_spec = [
     ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str("."), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
@@ -42,9 +43,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=setuptools.find_packages(),
-    install_requires=[
-        "jupyter_server>=1.6,<2"
-    ],
+    install_requires=[],
     zip_safe=False,
     include_package_data=True,
     python_requires=">=3.6",
@@ -71,10 +70,14 @@
     post_develop = npm_builder(
         build_cmd="install:extension", source_dir="src", build_dir=lab_path
     )
-    setup_args['cmdclass'] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
-    setup_args['data_files'] = get_data_files(data_files_spec)
+    setup_args["cmdclass"] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
+    setup_args["data_files"] = get_data_files(data_files_spec)
 except ImportError as e:
-    pass
+    import logging
+    logging.basicConfig(format="%(levelname)s: %(message)s")
+    logging.warning("Build tool `jupyter-packaging` is missing. Install it with pip or conda.")
+    if not ("--name" in sys.argv or "--version" in sys.argv):
+        raise e
 
 if __name__ == "__main__":
     setuptools.setup(**setup_args)