tickets/DM-48012: enable tutorial extension #141
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| "on": | |
| merge_group: {} | |
| pull_request: {} | |
| push: | |
| branches-ignore: | |
| # These should always correspond to pull requests, so ignore them for | |
| # the push trigger and let them be triggered by the pull_request | |
| # trigger, avoiding running the workflow twice. This is a minor | |
| # optimization so there's no need to ensure this is comprehensive. | |
| - "dependabot/**" | |
| - "gh-readonly-queue/**" | |
| - "renovate/**" | |
| - "tickets/**" | |
| - "u/**" | |
| tags: | |
| - "*" | |
| release: | |
| types: [published] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Base Setup | |
| uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 | |
| - name: Install dependencies | |
| run: python -m pip install -U "jupyterlab>=4.0.0,<5" | |
| - name: Lint the extension | |
| run: | | |
| set -eux | |
| jlpm | |
| jlpm run lint:check | |
| - name: Test the extension | |
| run: | | |
| set -eux | |
| jlpm run test | |
| - name: Build the extension | |
| env: | |
| # Enough to fake being an RSP instance | |
| # Used by displayversion | |
| IMAGE_DESCRIPTION: "w_2024_47 experimental" | |
| IMAGE_DIGEST: "e51a5b52ea0149c2d8a66dbef7ccb0cdb31470ed74025f7922e46555e96aa30a" | |
| JUPYTER_IMAGE_SPEC: "us-central1-docker.pkg.dev/rubin-shared-services-71ec/sciplat/sciplat-lab:exp_w_2024_47_tut_ext@sha256:e51a5b52ea0149c2d8a66dbef7ccb0cdb31470ed74025f7922e46555e96aa30a" | |
| EXTERNAL_INSTANCE_URL: "http://localhost:8080" | |
| CONTAINER_SIZE: "Small (1.0 CPU, 4Gi RAM)" | |
| # Used by savequit | |
| JUPYTERHUB_USER: "irian" | |
| JUPYTERHUB_API_TOKEN: "some-token" | |
| JUPYTERHUB_API_URL: "http://localhost:8080/nb/hub/api" | |
| JUPYTERHUB_API_SERVICE_PREFIX: "/nb/user/${JUPYTERHUB_USER}/" | |
| # Used by tutorials | |
| HOME: "/home/runner/work" | |
| TUTORIAL_NOTEBOOKS_DIR: "/home/runner/work/git/tutorial-notebooks" | |
| AUTO_REPO_SPECS: "https://github.com/rubin-dp0/tutorial-notebooks@prod" | |
| run: | | |
| mkdir -p /home/runner/work/git/tutorial-notebooks | |
| cat << EOF > /home/runner/work/git/tutorial-notebooks/hello.ipynb | |
| { | |
| "cells": [ | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "id": "779c8f6d-81b3-4c66-a6ce-c6ccbf16bc65", | |
| "metadata": {}, | |
| "outputs": [], | |
| "source": [ | |
| "print(\"Hello, world!\")" | |
| ] | |
| } | |
| ], | |
| "metadata": { | |
| "kernelspec": { | |
| "display_name": "Python 3 (ipykernel)", | |
| "language": "python", | |
| "name": "python3" | |
| }, | |
| "language_info": { | |
| "codemirror_mode": { | |
| "name": "ipython", | |
| "version": 3 | |
| }, | |
| "file_extension": ".py", | |
| "mimetype": "text/x-python", | |
| "name": "python", | |
| "nbconvert_exporter": "python", | |
| "pygments_lexer": "ipython3", | |
| "version": "3.11.10" | |
| } | |
| }, | |
| "nbformat": 4, | |
| "nbformat_minor": 5 | |
| } | |
| EOF | |
| python -m pip install .[test] | |
| pytest -vv -r ap --cov rsp_jupyter_extensions | |
| jupyter server extension list | |
| jupyter server extension list 2>&1 | grep -ie "rsp_jupyter_extensions.*OK" | |
| jupyter labextension list | |
| jupyter labextension list 2>&1 | grep -ie "rsp-jupyter-extensions.*OK" | |
| python -m jupyterlab.browser_check | |
| - name: Package the extension | |
| run: | | |
| set -eux | |
| pip install build | |
| python -m build | |
| pip uninstall -y "rsp_jupyter_extensions" jupyterlab | |
| - name: Upload extension packages | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: extension-artifacts | |
| path: dist/rsp_jupyter_extensions* | |
| if-no-files-found: error | |
| test_isolated: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Install Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| architecture: 'x64' | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: extension-artifacts | |
| - name: Install and Test | |
| run: | | |
| set -eux | |
| # Remove NodeJS, twice to take care of system and locally installed node versions. | |
| sudo rm -rf $(which node) | |
| sudo rm -rf $(which node) | |
| pip install "jupyterlab>=4.0.0,<5" rsp_jupyter_extensions*.whl | |
| jupyter server extension list | |
| jupyter server extension list 2>&1 | grep -ie "rsp_jupyter_extensions.*OK" | |
| jupyter labextension list | |
| jupyter labextension list 2>&1 | grep -ie "rsp-jupyter-extensions.*OK" | |
| python -m jupyterlab.browser_check --no-browser-test | |
| integration-tests: | |
| name: Integration tests | |
| needs: build | |
| runs-on: ubuntu-latest | |
| env: | |
| PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Base Setup | |
| uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 | |
| - name: Download extension package | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: extension-artifacts | |
| - name: Install the extension | |
| run: | | |
| set -eux | |
| python -m pip install "jupyterlab>=4.0.0,<5" rsp_jupyter_extensions*.whl | |
| - name: Install dependencies | |
| working-directory: ui-tests | |
| env: | |
| YARN_ENABLE_IMMUTABLE_INSTALLS: 0 | |
| PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1 | |
| run: jlpm install | |
| - name: Set up browser cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ${{ github.workspace }}/pw-browsers | |
| key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }} | |
| - name: Install browser | |
| run: jlpm playwright install chromium | |
| working-directory: ui-tests | |
| - name: Execute integration tests | |
| working-directory: ui-tests | |
| env: | |
| # Enough to fake being an RSP instance | |
| # Used by displayversion | |
| IMAGE_DESCRIPTION: "w_2024_47 experimental" | |
| IMAGE_DIGEST: "e51a5b52ea0149c2d8a66dbef7ccb0cdb31470ed74025f7922e46555e96aa30a" | |
| JUPYTER_IMAGE_SPEC: "us-central1-docker.pkg.dev/rubin-shared-services-71ec/sciplat/sciplat-lab:exp_w_2024_47_tut_ext@sha256:e51a5b52ea0149c2d8a66dbef7ccb0cdb31470ed74025f7922e46555e96aa30a" | |
| EXTERNAL_INSTANCE_URL: "http://localhost:8080" | |
| CONTAINER_SIZE: "Small (1.0 CPU, 4Gi RAM)" | |
| # Used by savequit | |
| JUPYTERHUB_USER: "irian" | |
| JUPYTERHUB_API_TOKEN: "some-token" | |
| JUPYTERHUB_API_URL: "http://localhost:8080/nb/hub/api" | |
| JUPYTERHUB_API_SERVICE_PREFIX: "/nb/user/${JUPYTERHUB_USER}/" | |
| # Used by tutorials | |
| HOME: "/home/runner/work" | |
| TUTORIAL_NOTEBOOKS_DIR: "/home/runner/work/git/tutorial-notebooks" | |
| AUTO_REPO_SPECS: "https://github.com/rubin-dp0/tutorial-notebooks@prod" | |
| run: | | |
| mkdir -p /home/runner/work/git/tutorial-notebooks | |
| cat << EOF > /home/runner/work/git/tutorial-notebooks/hello.ipynb | |
| { | |
| "cells": [ | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "id": "779c8f6d-81b3-4c66-a6ce-c6ccbf16bc65", | |
| "metadata": {}, | |
| "outputs": [], | |
| "source": [ | |
| "print(\"Hello, world!\")" | |
| ] | |
| } | |
| ], | |
| "metadata": { | |
| "kernelspec": { | |
| "display_name": "Python 3 (ipykernel)", | |
| "language": "python", | |
| "name": "python3" | |
| }, | |
| "language_info": { | |
| "codemirror_mode": { | |
| "name": "ipython", | |
| "version": 3 | |
| }, | |
| "file_extension": ".py", | |
| "mimetype": "text/x-python", | |
| "name": "python", | |
| "nbconvert_exporter": "python", | |
| "pygments_lexer": "ipython3", | |
| "version": "3.11.10" | |
| } | |
| }, | |
| "nbformat": 4, | |
| "nbformat_minor": 5 | |
| } | |
| EOF | |
| jlpm playwright test | |
| - name: Upload Playwright Test report | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: rsp_jupyter_extensions-playwright-tests | |
| path: | | |
| ui-tests/test-results | |
| ui-tests/playwright-report | |
| check_links: | |
| name: Check Links | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 | |
| - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1 | |
| pypi: | |
| # This job requires set up: | |
| # 1. Set up a trusted publisher for PyPI | |
| # 2. Set up a "pypi" environment in the repository | |
| # See https://github.com/lsst-sqre/build-and-publish-to-pypi | |
| name: Upload release to PyPI | |
| runs-on: ubuntu-latest | |
| needs: [build, test_isolated, integration-tests, check_links] | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/rsp-jupyter-extensions | |
| permissions: | |
| id-token: write | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # full history for setuptools_scm | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: extension-artifacts | |
| - run: | | |
| mkdir -p dist | |
| ls -lR | |
| cp rsp_jupyter_extensions*.whl rsp_jupyter_extensions*.gz dist | |
| - name: Publish package distribution to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |