Skip to content

Commit 4a133b5

Browse files
authored
Review the CI / comment pull requests (#1179)
* Add a link to Binder on PRs * There is no minus in rc or dev version numbers * Install notebook>=7 on Binder * Add test-unit-functional-integration and test-ui as dependencies for the ci and publish runs
1 parent f873cc3 commit 4a133b5

6 files changed

Lines changed: 54 additions & 8 deletions

File tree

.github/workflows/ci.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ concurrency:
3030
cancel-in-progress: true
3131

3232
jobs:
33+
comment-pr:
34+
permissions:
35+
pull-requests: write
36+
uses: ./.github/workflows/step_comment-pr.yml
37+
3338
pre-commit:
3439
uses: ./.github/workflows/step_pre-commit.yml
3540

@@ -54,7 +59,7 @@ jobs:
5459
uses: ./.github/workflows/step_tests-ui.yml
5560

5661
build:
57-
needs: [test-pip, test-conda, test-ui]
62+
needs: [test-pip, test-conda, test-unit-functional-integration, test-ui]
5863
uses: ./.github/workflows/step_build.yml
5964
with:
6065
upload: ${{ inputs.upload-build-artifacts || false }}

.github/workflows/publish.yml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ on:
33
push:
44
tags:
55
- "v[0-9]+.[0-9]+.[0-9]+"
6-
- "v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+"
7-
- "v[0-9]+.[0-9]+.[0-9]+-dev[0-9]+"
6+
- "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
7+
- "v[0-9]+.[0-9]+.[0-9]+dev[0-9]+"
88

99
jobs:
1010
pre-commit:
@@ -18,12 +18,20 @@ jobs:
1818
needs: [ codeql ]
1919
uses: ./.github/workflows/step_tests-pip.yml
2020

21+
test-unit-functional-integration:
22+
needs: [ codeql ]
23+
uses: ./.github/workflows/step_test_unit_functional.yml
24+
2125
test-conda:
2226
needs: [ codeql ]
2327
uses: ./.github/workflows/step_tests-conda.yml
2428

29+
test-ui:
30+
needs: [ codeql ]
31+
uses: ./.github/workflows/step_tests-ui.yml
32+
2533
build:
26-
needs: [ test-pip, test-conda ]
34+
needs: [ test-pip, test-conda, test-unit-functional-integration, test-ui ]
2735
uses: ./.github/workflows/step_build.yml
2836

2937
publish:
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: comment-pr
2+
run-name: Comment PR
3+
4+
on:
5+
workflow_call:
6+
7+
jobs:
8+
comment-pr:
9+
runs-on: ubuntu-latest
10+
name: Comment PR
11+
if: github.event_name == 'pull_request'
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
16+
- name: Comment PR
17+
uses: thollander/actions-comment-pull-request@v2
18+
with:
19+
message: |
20+
Thank you for making this pull request.
21+
22+
Did you know? You can try it on Binder: [![Binder:lab](https://img.shields.io/badge/binder-jupyterlab-0172B2.svg)](https://mybinder.org/v2/gh/${{ github.repository }}/${{ github.head_ref }}?urlpath=lab/tree/demo/get_started.ipynb) or [![Binder:notebook](https://img.shields.io/badge/binder-notebook-0172B2.svg)](https://mybinder.org/v2/gh/${{ github.repository }}/${{ github.head_ref }}?filepath=demo).
23+
24+
Also, the version of Jupytext developed in this PR can be installed with `pip`:
25+
```
26+
pip install git+https://github.com/${{ github.repository }}.git@${{ github.head_ref }}
27+
```
28+
(this requires `nodejs`, see more at [Developing Jupytext](https://jupytext.readthedocs.io/en/latest/developing.html))
29+
comment_tag: binder_link

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupytext.svg)](https://anaconda.org/conda-forge/jupytext)
1111
[![Pypi](https://img.shields.io/pypi/v/jupytext.svg)](https://pypi.python.org/pypi/jupytext)
1212
[![pyversions](https://img.shields.io/pypi/pyversions/jupytext.svg)](https://pypi.python.org/pypi/jupytext)
13-
[![Binder:notebook](https://img.shields.io/badge/binder-notebook-0172B2.svg)](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
1413
[![Binder:lab](https://img.shields.io/badge/binder-jupyterlab-0172B2.svg)](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
14+
[![Binder:notebook](https://img.shields.io/badge/binder-notebook-0172B2.svg)](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
1515
[![launch - renku](https://renkulab.io/renku-badge.svg)](https://renkulab.io/projects/best-practices/jupytext/sessions/new?autostart=1)
1616
[![](https://img.shields.io/badge/YouTube-JupyterCon%202020-red.svg)](https://www.youtube.com/watch?v=SDYdeVfMh48)
1717

binder/requirements.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
jupyterlab>=4
2+
notebook>=7
23
plotly
34
matplotlib
45
wordcloud
56
pandas
67
wbdata
78
bash_kernel
8-
# https://github.com/mwouts/jupytext/issues/1051
9-
nbclassic>=0.5.5

docs/developing.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ If you want to test a feature that has been integrated in `main` but not deliver
77
pip install git+https://github.com/mwouts/jupytext.git
88
```
99

10-
If you want only to build Jupytext core (e.g. not the JupyterLab extension) you can prefix the
10+
The above requires `node`. You can install it with e.g.
11+
```
12+
conda install 'nodejs>=20' -c conda-forge
13+
```
14+
15+
Alternatively you can build only Jupytext core (e.g. skip the JupyterLab extension). To do so, prefix the
1116
above with `HATCH_BUILD_HOOKS_ENABLE=false`.
1217

1318
Finally, if you want to test a development branch, use

0 commit comments

Comments
 (0)