Skip to content

Commit 5a8274c

Browse files
committed
Add custom launcher
1 parent 67401e5 commit 5a8274c

27 files changed

+1224
-20
lines changed

.github/workflows/test.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,9 @@ jobs:
2323
- name: Build the JupyterLite site
2424
run: |
2525
cp README.md content
26+
cd tskit-launcher
27+
jlpm install
28+
jlpm run build
29+
pip install -e .
30+
cd ..
2631
jupyter lite build --contents content --output-dir dist

repl/jupyter-lite.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
"jupyter-lite-schema-version": 0,
33
"jupyter-config-data": {
44
"disabledExtensions": [
5-
"@jupyterlab/drawio-extension",
6-
"jupyterlab-kernel-spy",
7-
"jupyterlab-tour"
5+
// "@jupyterlab/drawio-extension",
6+
// "jupyterlab-kernel-spy",
7+
"@jupyterlab/launcher",
8+
"@jupyterlab/launcher-extension",
9+
"@jupyterlab/launcher-extension:plugin"
10+
"@jupyterlab/application-extension:logo"
811
]
912
}
1013
}

repl/jupyter_lite_config.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"LiteBuildConfig": {
3+
"contents": ["content"],
4+
"output_dir": "dist"
5+
},
6+
"FederatedExtensionAddon": {
7+
"enabled_extensions": ["tskit_custom_jupyter_launcher"]
8+
}
9+
}

requirements.txt

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,13 @@ notebook~=7.4.3
77
# Python kernel (optional)
88
jupyterlite-pyodide-kernel==0.6.1
99

10-
# JavaScript kernel (optional)
11-
jupyterlite-javascript-kernel==0.3.0
12-
13-
# Language support (optional)
14-
jupyterlab-language-pack-fr-FR
15-
jupyterlab-language-pack-zh-CN
16-
17-
# P5 kernel (optional)
18-
jupyterlite-p5-kernel==0.1.0
1910

2011
# JupyterLab: Fasta file renderer (optional)
2112
jupyterlab-fasta>=3.3.0,<4
2213
# JupyterLab: Geojson file renderer (optional)
2314
jupyterlab-geojson>=3.4.0,<4
2415
# JupyterLab: guided tour (optional)
25-
# TODO: re-enable after https://github.com/jupyterlab-contrib/jupyterlab-tour/issues/82
26-
# jupyterlab-tour
16+
jupyterlab-tour
2717
# JupyterLab: dark theme
2818
jupyterlab-night
2919
# JupyterLab: Miami nights theme (optional)
@@ -37,9 +27,3 @@ ipyevents>=2.0.1
3727
ipympl>=0.8.2
3828
# Python: ipycanvas library for Jupyter notebooks (optional)
3929
ipycanvas>=0.9.1
40-
# Python: ipyleaflet library for Jupyter notebooks (optional)
41-
ipyleaflet
42-
43-
# Python: plotting libraries (optional)
44-
plotly>=6,<7
45-
bqplot

tskit-launcher/.copier-answers.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2+
_commit: v4.3.8
3+
_src_path: https://github.com/jupyterlab/extension-template
4+
author_email: ben.jeffery@bdi.ox.ac.uk
5+
author_name: tskit-launcher
6+
data_format: string
7+
file_extension: ''
8+
has_binder: false
9+
has_settings: false
10+
kind: frontend
11+
labextension_name: tskit_launcher
12+
mimetype: ''
13+
mimetype_name: ''
14+
project_short_description: Tskit custom launcher
15+
python_name: tskit_launcher
16+
repository: n/a
17+
test: false
18+
viewer_name: ''
19+
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches: main
6+
pull_request:
7+
branches: '*'
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
21+
- name: Base Setup
22+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23+
24+
- name: Install dependencies
25+
run: python -m pip install -U "jupyterlab>=4.0.0,<5"
26+
27+
- name: Lint the extension
28+
run: |
29+
set -eux
30+
jlpm
31+
jlpm run lint:check
32+
33+
- name: Build the extension
34+
run: |
35+
set -eux
36+
python -m pip install .[test]
37+
38+
jupyter labextension list
39+
jupyter labextension list 2>&1 | grep -ie "tskit_launcher.*OK"
40+
python -m jupyterlab.browser_check
41+
42+
- name: Package the extension
43+
run: |
44+
set -eux
45+
46+
pip install build
47+
python -m build
48+
pip uninstall -y "tskit_launcher" jupyterlab
49+
50+
- name: Upload extension packages
51+
uses: actions/upload-artifact@v4
52+
with:
53+
name: extension-artifacts
54+
path: dist/tskit_launcher*
55+
if-no-files-found: error
56+
57+
test_isolated:
58+
needs: build
59+
runs-on: ubuntu-latest
60+
61+
steps:
62+
- name: Install Python
63+
uses: actions/setup-python@v5
64+
with:
65+
python-version: '3.9'
66+
architecture: 'x64'
67+
- uses: actions/download-artifact@v4
68+
with:
69+
name: extension-artifacts
70+
- name: Install and Test
71+
run: |
72+
set -eux
73+
# Remove NodeJS, twice to take care of system and locally installed node versions.
74+
sudo rm -rf $(which node)
75+
sudo rm -rf $(which node)
76+
77+
pip install "jupyterlab>=4.0.0,<5" tskit_launcher*.whl
78+
79+
80+
jupyter labextension list
81+
jupyter labextension list 2>&1 | grep -ie "tskit_launcher.*OK"
82+
python -m jupyterlab.browser_check --no-browser-test
83+
84+
85+
check_links:
86+
name: Check Links
87+
runs-on: ubuntu-latest
88+
timeout-minutes: 15
89+
steps:
90+
- uses: actions/checkout@v4
91+
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
92+
- uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Check Release
2+
on:
3+
push:
4+
branches: ["main"]
5+
pull_request:
6+
branches: ["*"]
7+
8+
concurrency:
9+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
check_release:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
- name: Base Setup
19+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
20+
- name: Check Release
21+
uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
22+
with:
23+
24+
token: ${{ secrets.GITHUB_TOKEN }}
25+
26+
- name: Upload Distributions
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: tskit_launcher-releaser-dist-${{ github.run_number }}
30+
path: .jupyter_releaser_checkout/dist
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Enforce PR label
2+
3+
on:
4+
pull_request:
5+
types: [labeled, unlabeled, opened, edited, synchronize]
6+
jobs:
7+
enforce-label:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
pull-requests: write
11+
steps:
12+
- name: enforce-triage-label
13+
uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: "Step 1: Prep Release"
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
version_spec:
6+
description: "New Version Specifier"
7+
default: "next"
8+
required: false
9+
branch:
10+
description: "The branch to target"
11+
required: false
12+
post_version_spec:
13+
description: "Post Version Specifier"
14+
required: false
15+
# silent:
16+
# description: "Set a placeholder in the changelog and don't publish the release."
17+
# required: false
18+
# type: boolean
19+
since:
20+
description: "Use PRs with activity since this date or git reference"
21+
required: false
22+
since_last_stable:
23+
description: "Use PRs with activity since the last stable git tag"
24+
required: false
25+
type: boolean
26+
jobs:
27+
prep_release:
28+
runs-on: ubuntu-latest
29+
permissions:
30+
contents: write
31+
steps:
32+
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
33+
34+
- name: Prep Release
35+
id: prep-release
36+
uses: jupyter-server/jupyter_releaser/.github/actions/prep-release@v2
37+
with:
38+
token: ${{ secrets.GITHUB_TOKEN }}
39+
version_spec: ${{ github.event.inputs.version_spec }}
40+
# silent: ${{ github.event.inputs.silent }}
41+
post_version_spec: ${{ github.event.inputs.post_version_spec }}
42+
branch: ${{ github.event.inputs.branch }}
43+
since: ${{ github.event.inputs.since }}
44+
since_last_stable: ${{ github.event.inputs.since_last_stable }}
45+
46+
- name: "** Next Step **"
47+
run: |
48+
echo "Optional): Review Draft Release: ${{ steps.prep-release.outputs.release_url }}"
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: "Step 2: Publish Release"
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
branch:
6+
description: "The target branch"
7+
required: false
8+
release_url:
9+
description: "The URL of the draft GitHub release"
10+
required: false
11+
steps_to_skip:
12+
description: "Comma separated list of steps to skip"
13+
required: false
14+
15+
jobs:
16+
publish_release:
17+
runs-on: ubuntu-latest
18+
environment: release
19+
permissions:
20+
id-token: write
21+
steps:
22+
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23+
24+
- uses: actions/create-github-app-token@v1
25+
id: app-token
26+
with:
27+
app-id: ${{ vars.APP_ID }}
28+
private-key: ${{ secrets.APP_PRIVATE_KEY }}
29+
30+
- name: Populate Release
31+
id: populate-release
32+
uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
33+
with:
34+
token: ${{ steps.app-token.outputs.token }}
35+
branch: ${{ github.event.inputs.branch }}
36+
release_url: ${{ github.event.inputs.release_url }}
37+
steps_to_skip: ${{ github.event.inputs.steps_to_skip }}
38+
39+
- name: Finalize Release
40+
id: finalize-release
41+
env:
42+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
43+
uses: jupyter-server/jupyter_releaser/.github/actions/finalize-release@v2
44+
with:
45+
token: ${{ steps.app-token.outputs.token }}
46+
release_url: ${{ steps.populate-release.outputs.release_url }}
47+
48+
- name: "** Next Step **"
49+
if: ${{ success() }}
50+
run: |
51+
echo "Verify the final release"
52+
echo ${{ steps.finalize-release.outputs.release_url }}
53+
54+
- name: "** Failure Message **"
55+
if: ${{ failure() }}
56+
run: |
57+
echo "Failed to Publish the Draft Release Url:"
58+
echo ${{ steps.populate-release.outputs.release_url }}

0 commit comments

Comments
 (0)