You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,30 @@ Some _very_ infrequent manual tasks (interacting with the fastly cache layer) ar
13
13
We're mostly trying to move away from that, but tasks are infrequent enough.
14
14
Let's not add to them, though.
15
15
16
-
## Automation progress
16
+
## Automation
17
17
18
-
- helm upgrade is now in `.github/workflows/cd.yml`
19
-
-updating nbviewer is still manual (`config.yaml` and `cd.yaml`)
18
+
- helm upgrade happens when PRs are merged in `.github/workflows/cd.yml`
19
+
-The nbviewer repo is automatically checked for updates in `.github/workflows/watch-dependencies`
20
20
21
21
## Quickstart: upgrading nbviewer
22
22
23
-
nbviewer helm upgrades are deployed via github actions.
24
-
The nbviewer version is current in two palaces:
23
+
nbviewer publishes its images automatically.
24
+
If a change you want to deploy was merged recently,
25
+
make sure to wait for the image to be published to Docker Hub
26
+
(takes a few minutes).
27
+
28
+
Checking for nbviewer updates and deploying to nbviewer.org is done automatically every day.
29
+
30
+
To manually run a check for the latest version of nbviewer, run the [watch-dependencies](https://github.com/jupyter/nbviewer.org-deploy/actions/workflows/watch-dependencies.yaml) action.
31
+
This should open a PR with any changes.
32
+
33
+
You can also check for updates manually with `python3 scripts/update-nbviewer.py`, and open a PR yourself.
34
+
35
+
When that PR is merged, the updated nbviewer will be deployed.
36
+
37
+
### Upgrading details
38
+
39
+
The nbviewer version is current in two places:
25
40
26
41
- the _chart_ version in `.github/workflows/cd.yml`
27
42
- the _image_ version in `config/nbviewer.yaml`
@@ -33,9 +48,9 @@ To deploy an update from nbviewer to nbviewer.org:
33
48
3. check the latest tag of the [nbviewer image](https://hub.docker.com/r/jupyter/nbviewer/tags)
34
49
4. update the tag in [config/nbviewer.yaml](config/nbviewer.yaml)
35
50
36
-
Open a pull request, and it should be deployed to nbviewer.org upon merge.
51
+
These steps are scripted in `scripts/update-nbviewer.py`.
37
52
38
-
Generating these pull requests _should_ be automated, as is done [on mybinder.org-deploy](https://github.com/jupyterhub/mybinder.org-deploy/pull/3427).
53
+
Open a pull request, and it should be deployed to nbviewer.org upon merge.
39
54
40
55
## Current deployment
41
56
@@ -47,7 +62,6 @@ Python dependencies:
47
62
48
63
pip install -r requirements.in # (or requirements.txt for a locked env)
0 commit comments