Skip to content

Commit 341706e

Browse files
committed
update readme now that we should get bot prs
1 parent 16e0e8f commit 341706e

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

.github/workflows/watch-dependencies.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
- name: install requirements
3232
run: |
3333
pip install -r requirements.txt
34-
34+
3535
- name: Check for nbviewer updates
3636
id: update
3737
run: |

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,30 @@ Some _very_ infrequent manual tasks (interacting with the fastly cache layer) ar
1313
We're mostly trying to move away from that, but tasks are infrequent enough.
1414
Let's not add to them, though.
1515

16-
## Automation progress
16+
## Automation
1717

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`
2020

2121
## Quickstart: upgrading nbviewer
2222

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:
2540

2641
- the _chart_ version in `.github/workflows/cd.yml`
2742
- the _image_ version in `config/nbviewer.yaml`
@@ -33,9 +48,9 @@ To deploy an update from nbviewer to nbviewer.org:
3348
3. check the latest tag of the [nbviewer image](https://hub.docker.com/r/jupyter/nbviewer/tags)
3449
4. update the tag in [config/nbviewer.yaml](config/nbviewer.yaml)
3550

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`.
3752

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.
3954

4055
## Current deployment
4156

@@ -47,7 +62,6 @@ Python dependencies:
4762

4863
pip install -r requirements.in # (or requirements.txt for a locked env)
4964

50-
5165
## TODO
5266

5367
- Fastly is scripted now, but we could do better.

0 commit comments

Comments
 (0)