Skip to content

Commit

Permalink
Merge pull request #289 from rstudio/tdstein/jupyterlab-ci
Browse files Browse the repository at this point in the history
JupyterLab CI
  • Loading branch information
tdstein authored Oct 14, 2023
2 parents 42c65fc + e097389 commit 16a6000
Show file tree
Hide file tree
Showing 80 changed files with 21,005 additions and 204 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/extensions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Extensions
on:
workflow_call:
jobs:
jupyterlab:
env:
DOCKER: false
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: extractions/setup-just@v1
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- run: just jupyterlab install
- run: just jupyterlab lint
- run: just jupyterlab test
2 changes: 2 additions & 0 deletions .github/workflows/pull-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
jobs:
agent:
uses: ./.github/workflows/agent.yaml
extensions:
uses: ./.github/workflows/extensions.yaml
web:
uses: ./.github/workflows/web.yaml
build:
Expand Down
9 changes: 9 additions & 0 deletions cmd/connect-client/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package main

import (
"os"
"runtime/pprof"

"github.com/alecthomas/kong"
"github.com/rstudio/connect-client/cmd/connect-client/commands"
Expand Down Expand Up @@ -63,6 +64,14 @@ func main() {
}
// Dispatch to the Run() method of the selected command.
args := kong.Parse(&cli, kong.Bind(ctx))
if cli.Profile != "" {
f, err := os.Create(cli.Profile)
if err != nil {
Fatal(log, "Error creating file for profile data", err)
}
pprof.StartCPUProfile(f)
defer pprof.StopCPUProfile()
}
if cli.Debug {
ctx.Logger = events.NewLogger(true)
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
These workflow files come with the JupyterLab extension template.
We've removed some parts we don't intend to use. The rest
are left here as a reference for when we build the extension
in CI.
130 changes: 130 additions & 0 deletions extensions/jupyterlab/connect_jupyterlab/.github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
name: Build

on:
push:
branches: main
pull_request:
branches: '*'

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- 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
run: |
set -eux
python -m pip install .[test]
pytest -vv -r ap --cov connect_jupyterlab
jupyter server extension list
jupyter server extension list 2>&1 | grep -ie "connect_jupyterlab.*OK"
jupyter labextension list
jupyter labextension list 2>&1 | grep -ie "connect_jupyterlab.*OK"
python -m jupyterlab.browser_check
- name: Package the extension
run: |
set -eux
pip install build
python -m build
pip uninstall -y "connect_jupyterlab" jupyterlab
- name: Upload extension packages
uses: actions/upload-artifact@v3
with:
name: extension-artifacts
path: dist/connect_jupyterlab*
if-no-files-found: error

test_isolated:
needs: build
runs-on: ubuntu-latest

steps:
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
architecture: 'x64'
- uses: actions/download-artifact@v3
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" connect_jupyterlab*.whl
jupyter server extension list
jupyter server extension list 2>&1 | grep -ie "connect_jupyterlab.*OK"
jupyter labextension list
jupyter labextension list 2>&1 | grep -ie "connect_jupyterlab.*OK"
python -m jupyterlab.browser_check --no-browser-test
integration-tests:
name: Integration tests
needs: build
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Download extension package
uses: actions/download-artifact@v3
with:
name: extension-artifacts

- name: Install the extension
run: |
set -eux
python -m pip install "jupyterlab>=4.0.0,<5" connect_jupyterlab*.whl
- name: Install dependencies
working-directory: ui-tests
run: jlpm install

- name: Execute integration tests
working-directory: ui-tests
run: |
tbd
check_links:
name: Check Links
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v3
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Check Release
on:
push:
branches: ["main"]
pull_request:
branches: ["*"]

jobs:
check_release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Check Release
uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
with:

token: ${{ secrets.GITHUB_TOKEN }}

- name: Upload Distributions
uses: actions/upload-artifact@v3
with:
name: connect_jupyterlab-releaser-dist-${{ github.run_number }}
path: .jupyter_releaser_checkout/dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "Step 1: Prep Release"
on:
workflow_dispatch:
inputs:
version_spec:
description: "New Version Specifier"
default: "next"
required: false
branch:
description: "The branch to target"
required: false
post_version_spec:
description: "Post Version Specifier"
required: false
since:
description: "Use PRs with activity since this date or git reference"
required: false
since_last_stable:
description: "Use PRs with activity since the last stable git tag"
required: false
type: boolean
jobs:
prep_release:
runs-on: ubuntu-latest
steps:
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Prep Release
id: prep-release
uses: jupyter-server/jupyter_releaser/.github/actions/prep-release@v2
with:
token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
version_spec: ${{ github.event.inputs.version_spec }}
post_version_spec: ${{ github.event.inputs.post_version_spec }}
branch: ${{ github.event.inputs.branch }}
since: ${{ github.event.inputs.since }}
since_last_stable: ${{ github.event.inputs.since_last_stable }}

- name: "** Next Step **"
run: |
echo "Optional): Review Draft Release: ${{ steps.prep-release.outputs.release_url }}"
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: "Step 2: Publish Release"
on:
workflow_dispatch:
inputs:
branch:
description: "The target branch"
required: false
release_url:
description: "The URL of the draft GitHub release"
required: false
steps_to_skip:
description: "Comma separated list of steps to skip"
required: false

jobs:
publish_release:
runs-on: ubuntu-latest
permissions:
# This is useful if you want to use PyPI trusted publisher
# and NPM provenance
id-token: write
steps:
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

- name: Populate Release
id: populate-release
uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
with:
token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
branch: ${{ github.event.inputs.branch }}
release_url: ${{ github.event.inputs.release_url }}
steps_to_skip: ${{ github.event.inputs.steps_to_skip }}

- name: Finalize Release
id: finalize-release
env:
# The following are needed if you use legacy PyPI set up
# PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
# PYPI_TOKEN_MAP: ${{ secrets.PYPI_TOKEN_MAP }}
# TWINE_USERNAME: __token__
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
uses: jupyter-server/jupyter-releaser/.github/actions/finalize-release@v2
with:
token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
release_url: ${{ steps.populate-release.outputs.release_url }}

- name: "** Next Step **"
if: ${{ success() }}
run: |
echo "Verify the final release"
echo ${{ steps.finalize-release.outputs.release_url }}
- name: "** Failure Message **"
if: ${{ failure() }}
run: |
echo "Failed to Publish the Draft Release Url:"
echo ${{ steps.populate-release.outputs.release_url }}
Loading

0 comments on commit 16a6000

Please sign in to comment.