Backport PR #10673: Clean up link checking (#10674)

Co-authored-by: Steven Silvester <steven.silvester@ieee.org>

pyproject.toml

@@ -24,6 +24,9 @@ ignore="tests examples"
 [tool.check-manifest]
 ignore = ["binder/**", "builder/**", "buildutils/**", "design/**", "dev_mode/**", "examples/**", "packages/**", "scripts/**", "testutils/**", "*.json", "yarn.lock", "readthedocs.yml", ".bumpversion.cfg", ".*", "clean.py", "lint-staged.config.js", "release/*", "typedoc-theme/**", "typedoc.js", "jupyterlab/schemas/**", "jupyterlab/static/**", "jupyterlab/themes/**", "jupyterlab/style.js"]
 
+[tool.jupyter-releaser]
+skip = ["check-links"]
+
 [tool.jupyter-releaser.options]
 ignore-glob = ["packages/ui-components/docs/source/ui_components.rst"]
 ignore-links = ["../api/*.*"]

scripts/ci_script.sh

@@ -49,33 +49,32 @@ if [[ $GROUP == docs ]]; then
 fi
 
 if [[ $GROUP == linkcheck ]]; then
-    # Build the docs
-    pushd docs
-    conda env create -f environment.yml
-    conda init --all
-    source $CONDA/bin/activate jupyterlab_documentation
-    make html
-    conda deactivate
-    popd
+    # Run the link check using the jupyter-releaser CLI
 
-    # Run the link check on the built html files
+    # Set up caching
     CACHE_DIR="${HOME}/.cache/pytest-link-check"
     mkdir -p ${CACHE_DIR}
     echo "Existing cache:"
     ls -ltr ${CACHE_DIR}
-    # Expire links after a week
-    LINKS_EXPIRE=604800
-    base_args="--check-links --check-links-cache --check-links-cache-expire-after ${LINKS_EXPIRE} --check-links-cache-name ${CACHE_DIR}/cache"
 
-    # Ignore pull requests and issues to the link check doesn't take all day
-    base_args="--check-links-ignore https://github.com/.*/(pull|issues)/.* ${base_args}"
+    # Set up env variables for releaser
+    export RH_CACHE_FILE=${CACHE_DIR}/cache
+    # Expire links after a week
+    export RH_LINKS_EXPIRE=604800
 
-    # Check built html files
-    args="--ignore docs/build/html/genindex.html --ignore docs/build/html/search.html --ignore docs/build/html/api ${base_args}"
-    py.test $args --links-ext .html -k .html docs/build/html || py.test $args --links-ext .html -k .html --lf docs/build/html
+    # Handle the branch
+    if [ ! -z ${GITHUB_BASE_REF} ]; then
+      echo "Using GITHUB_BASE_REF: ${GITHUB_BASE_REF}"
+      export RH_BRANCH=${GITHUB_BASE_REF}
+    else
+      # e.g refs/head/foo or refs/tag/bar
+      echo "Using GITHUB_REF: ${GITHUB_REF}"
+      export RH_BRANCH=$(echo ${GITHUB_REF} | cut -d'/' -f 3)
+    fi
 
-    # Check markdown files
-    py.test ${base_args} --links-ext .md -k .md . || py.test $args --links-ext .md -k .md --lf .
+    pip install jupyter_releaser
+    jupyter-releaser prep-git
+    jupyter-releaser check-links
 fi