Skip to content

Commit 007ef89

Browse files
krassowskikrassowski
authored
Merge pull request #280 from jtpio/bump-actions
Bump GitHub Actions to fix CI
2 parents 203393a + 799270e commit 007ef89

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

‎.github/workflows/main.yml

+19-19
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949

5050
steps:
5151
- name: Checkout
52-
uses: actions/checkout@v3
52+
uses: actions/checkout@v4
5353
- name: Path filter
5454
id: filter
5555
uses: dorny/paths-filter@v2
@@ -59,7 +59,7 @@ jobs:
5959
- '${{ matrix.example }}/**'
6060
- name: Cache lerna
6161
if: steps.filter.outputs.extension == 'true'
62-
uses: actions/cache@v3
62+
uses: actions/cache@v4
6363
with:
6464
path: '**/node_modules'
6565
key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json') }}
@@ -75,12 +75,12 @@ jobs:
7575
shell: bash
7676
- name: Install node
7777
if: steps.filter.outputs.extension == 'true'
78-
uses: actions/setup-node@v3
78+
uses: actions/setup-node@v4
7979
with:
8080
node-version: '18.x'
8181
- name: Install Python
8282
if: steps.filter.outputs.extension == 'true'
83-
uses: actions/setup-python@v4
83+
uses: actions/setup-python@v5
8484
with:
8585
python-version: '3.11'
8686
architecture: 'x64'
@@ -92,7 +92,7 @@ jobs:
9292
shell: bash
9393
- name: Cache pip
9494
if: steps.filter.outputs.extension == 'true'
95-
uses: actions/cache@v3
95+
uses: actions/cache@v4
9696
with:
9797
path: ${{ steps.pip-cache.outputs.dir }}
9898
key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}
@@ -138,7 +138,7 @@ jobs:
138138
run: jlpm install
139139
- name: Set up browser cache
140140
if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
141-
uses: actions/cache@v3
141+
uses: actions/cache@v4
142142
with:
143143
path: |
144144
${{ github.workspace }}/pw-browsers
@@ -156,7 +156,7 @@ jobs:
156156
run: jlpm playwright test
157157
- name: Upload UI Test artifacts
158158
if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
159-
uses: actions/upload-artifact@v3
159+
uses: actions/upload-artifact@v4
160160
with:
161161
name: ui-test-output
162162
path: |
@@ -175,7 +175,7 @@ jobs:
175175
os: [ubuntu-latest, macos-latest, windows-latest]
176176
steps:
177177
- name: Checkout
178-
uses: actions/checkout@v3
178+
uses: actions/checkout@v4
179179
- name: Path filter
180180
id: filter
181181
uses: dorny/paths-filter@v2
@@ -185,14 +185,14 @@ jobs:
185185
- 'server-extension/**'
186186
- name: Cache lerna
187187
if: steps.filter.outputs.extension == 'true'
188-
uses: actions/cache@v3
188+
uses: actions/cache@v4
189189
with:
190190
path: '**/node_modules'
191191
key: ${{ runner.os }}-lerna-${{ hashFiles('server-extension/package.json') }}
192192
restore-keys: ${{ runner.os }}-lerna-
193193
- name: Install node
194194
if: steps.filter.outputs.extension == 'true'
195-
uses: actions/setup-node@v3
195+
uses: actions/setup-node@v4
196196
with:
197197
node-version: '18.x'
198198
- name: Check config files
@@ -206,7 +206,7 @@ jobs:
206206
shell: bash
207207
- name: Install Python
208208
if: steps.filter.outputs.extension == 'true'
209-
uses: actions/setup-python@v4
209+
uses: actions/setup-python@v5
210210
with:
211211
python-version: '3.11'
212212
architecture: 'x64'
@@ -218,7 +218,7 @@ jobs:
218218
shell: bash
219219
- name: Cache pip
220220
if: steps.filter.outputs.extension == 'true'
221-
uses: actions/cache@v3
221+
uses: actions/cache@v4
222222
with:
223223
path: ${{ steps.pip-cache.outputs.dir }}
224224
key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}
@@ -282,7 +282,7 @@ jobs:
282282
run: jlpm install
283283
- name: Set up browser cache
284284
if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux')
285-
uses: actions/cache@v3
285+
uses: actions/cache@v4
286286
with:
287287
path: |
288288
${{ github.workspace }}/pw-browsers
@@ -297,7 +297,7 @@ jobs:
297297
run: jlpm playwright test
298298
- name: Upload UI Test artifacts
299299
if: steps.filter.outputs.extension == 'true' && startsWith(runner.os, 'Linux') && always()
300-
uses: actions/upload-artifact@v3
300+
uses: actions/upload-artifact@v4
301301
with:
302302
name: ui-test-output
303303
path: |
@@ -316,19 +316,19 @@ jobs:
316316
os: [ubuntu-latest, macos-latest, windows-latest]
317317
steps:
318318
- name: Checkout
319-
uses: actions/checkout@v3
319+
uses: actions/checkout@v4
320320
- name: Cache lerna
321-
uses: actions/cache@v3
321+
uses: actions/cache@v4
322322
with:
323323
path: '**/node_modules'
324324
key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json') }}
325325
restore-keys: ${{ runner.os }}-lerna-
326326
- name: Install node
327-
uses: actions/setup-node@v3
327+
uses: actions/setup-node@v4
328328
with:
329329
node-version: '18.x'
330330
- name: Install Python
331-
uses: actions/setup-python@v4
331+
uses: actions/setup-python@v5
332332
with:
333333
python-version: '3.11'
334334
architecture: 'x64'
@@ -338,7 +338,7 @@ jobs:
338338
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
339339
shell: bash
340340
- name: Cache pip
341-
uses: actions/cache@v3
341+
uses: actions/cache@v4
342342
with:
343343
path: ${{ steps.pip-cache.outputs.dir }}
344344
key: ${{ runner.os }}-pip-${{ hashFiles('environment.yml') }}

‎documents/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
## Introduction to documents
2020

21-
In JupyterLab, we refer to a _document_ a type of file stored on disk. These files are represented in the frontend by a [`Context`](https://jupyterlab.readthedocs.io/en/latest/api/classes/docregistry.Context-1.html) which is the bridge between the file metadata (like the file path) and its model (the actual document content). Document [`IModel`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IModel.html) represents the file content while [`IDocumentWidget`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.IDocumentWidget.html) is a view of the model.
21+
In JupyterLab, we refer to a _document_ a type of file stored on disk. These files are represented in the frontend by a [`Context`](https://jupyterlab.readthedocs.io/en/latest/api/classes/docregistry.Context-1.html) which is the bridge between the file metadata (like the file path) and its model (the actual document content). Document [`IModel`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IModel.html) represents the file content while [`IDocumentWidget`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.IDocumentWidget.html) is a view of the model.
2222
Developers can provide new extensions to support additional documents (or replace existing implementation). A document is defined by three elements:
2323

2424
- A model: it contains and handles the document content. It should implement the [`IModel` interface](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IModel.html). And in particular it should contain the document content in a [`sharedModel`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IModel.html#sharedModel) - so you will need to define two new model classes.
@@ -28,7 +28,7 @@ Developers can provide new extensions to support additional documents (or replac
2828
The model, the shared model and the view will be provided through new factories and the file type will be registered directly.
2929
For that you will need to access the [`DocumentRegistry`](https://jupyterlab.readthedocs.io/en/latest/api/classes/docregistry.DocumentRegistry-1.html) to register new [`FileType`s](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/rendermime_interfaces.IRenderMime.IFileType.html), models and views. This way, when opening a new file, the [`DocumentManager`](https://jupyterlab.readthedocs.io/en/latest/api/classes/docmanager.DocumentManager-1.html) will look into the file metadata and create an instance of `Context` with the right model for this file. To register new documents, you can create factories, either a [`IModelFactory`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IModelFactory.html) for the model and/or a [`IWidgetFactory`](https://jupyterlab.readthedocs.io/en/latest/api/interfaces/docregistry.DocumentRegistry.IWidgetFactory.html) for the view.
3030

31-
The shared model needs to be registered only if your file must be collaborative. For that you will need to register it in the [`ICollaborativeDrive`](https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/api/interfaces/collaborative_drive.ICollaborativeDrive.html) token provided by the `@jupyter/collaborative-drive` package.
31+
The shared model needs to be registered only if your file must be collaborative. For that you will need to register it in the [`ICollaborativeDrive`](https://jupyterlab-realtime-collaboration.readthedocs.io/en/stable/api/interfaces/collaborative_drive.ICollaborativeDrive.html) token provided by the `@jupyter/collaborative-drive` package.
3232

3333
> Packaging note: when using an optional external extension (here
3434
> `@jupyter/collaborative-drive` from `jupyter-collaboration`), you must
@@ -241,9 +241,9 @@ After a short explanation of Yjs' features, now it's time to start with the impl
241241

242242
First you need to define your document data structure. For a text file, it is as
243243
simple as a single string. But as mentioned earlier, it could be more complex. Here
244-
the document represents a cube by its position and text content. It is stored as a JSON with two keys: a _position_ and a _content_.
244+
the document represents a cube by its position and text content. It is stored as a JSON with two keys: a _position_ and a _content_.
245245
Although the position is also a dictionary with keys _x_ and _y_, we decided to store
246-
both information as string (i.e. position will require parsing to be converted as a dictionary).
246+
both information as string (i.e. position will require parsing to be converted as a dictionary).
247247
That choice is purely at the discretion of the developer. Using a stringified
248248
dictionary is fine if most of the dictionary changes every time. But if most of
249249
the dictionary stay constant (especially if the all dictionary is large), it would

0 commit comments

Comments
 (0)