move dependencies to update-nbviewer.py script so it can be run locally

Author: minrk

.github/workflows/watch-dependencies.yaml

@@ -1,5 +1,5 @@
 # automatically check for updates to nbviewer
-# adapted from mybinder.org-deploy, under BSD-3-Clause lience
+# adapted from mybinder.org-deploy, under BSD-3-Clause license
 name: Watch dependencies
 
 on:
@@ -25,39 +25,17 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
+          cache: pip
 
-      - name: Get current versions of jupyter/nbviewer
-        id: current
-        # get the version of the image and chart repo currently being deployed
+      - name: install requirements
         run: |
-          local_image=$(cat config/nbviewer.yaml | yq e '.image')
-          echo "tag=$local_image" >> $GITHUB_OUTPUT
-          local_chart=$(cat .github/workflows/cd.yml | yq e '.env.NBVIEWER_VERSION')
-          echo "chart=$local_chart" >> $GITHUB_OUTPUT
-
-      - name: Get latest versions jupyter/nbviewer
-        id: latest
-        # docker tags api sorts by date
-        # there is no version information in nbviewer image tags
+          pip install -r requirements.txt
+ 
+      - name: Check for nbviewer updates
+        id: update
         run: |
-          latest_tag=$(
-              curl https://hub.docker.com/v2/repositories/jupyter/nbviewer/tags | jq -r '.results[0].name'
-          )
-          echo "tag=jupyter/nbviewer:$latest_tag" >> $GITHUB_OUTPUT
-          head=$(
-            git ls-remote https://github.com/jupyter/nbviewer HEAD | cut -f1
-          )
-          echo "chart=$head" >> "$GITHUB_OUTPUT"
-          echo "short=${head::7}" >> "$GITHUB_OUTPUT"
-      
-      - name: Update nbviewer image
-        if: steps.local.outputs.tag != steps.latest.outputs.tag
-        run: sed --in-place 's@${{ steps.local.outputs.tag }}@${{ steps.latest.outputs.tag }}@g' config/nbviewer.yaml
-
-      - name: Update nbviewer chart
-        if: steps.local.outputs.chart != steps.latest.outputs.chart
-        run: sed --in-place 's@${{ steps.local.outputs.chart }}@${{ steps.latest.outputs.chart }}@g' .github/workflows/cd.yml
+          python3 scripts/update-nbviewer.py
 
       - name: git diff
         id: git-diff
@@ -72,11 +50,10 @@ jobs:
         id: prsummary
         if: steps.git-diff.changed
         run: |
-          pip install PyGithub
           ./scripts/get-prs.py \
               jupyter/nbviewer \
-              ${{ steps.local.outputs.chart }} \
-              ${{ steps.latest.outputs.chart }} \
+              ${{ steps.update.outputs.chart_before }} \
+              ${{ steps.update.outputs.chart_after }} \
               --write-github-actions-output=prs
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -93,11 +70,11 @@ jobs:
           committer: JupterHub Bot Account <[email protected]>
           branch: update-nbviewer
           labels: dependencies
-          commit-message: Update nbviewer version to ${{ steps.latest.outputs.short }}
-          title: Update nbviewer version to ${{ steps.latest.outputs.short }}
+          commit-message: Update nbviewer version to ${{ steps.update.outputs.chart_short }}
+          title: Update nbviewer version to ${{ steps.update.outputs.chart_short }}
           body: |
-            - Updates nbviewer chart to jupyter/nbviewer@${{ steps.latest.outputs.chart }}
-            - Update nbviewer image to `${{ steps.latest.outputs.tag }}`
+            - Updates nbviewer chart to jupyter/nbviewer@${{ steps.update.outputs.chart_after }}
+            - Update nbviewer image to `${{ steps.update.outputs.image_tag }}`
 
             ${{ steps.prsummary.outputs.prs }}
 

requirements.in

@@ -1,3 +1,5 @@
 beautifulsoup4
+pygithub
 pytest
+pyyaml
 requests

requirements.txt

@@ -8,8 +8,14 @@ beautifulsoup4==4.13.5
     # via -r requirements.in
 certifi==2025.8.3
     # via requests
+cffi==2.0.0
+    # via
+    #   cryptography
+    #   pynacl
 charset-normalizer==3.4.3
     # via requests
+cryptography==46.0.1
+    # via pyjwt
 idna==3.10
     # via requests
 iniconfig==2.1.0
@@ -18,15 +24,31 @@ packaging==25.0
     # via pytest
 pluggy==1.6.0
     # via pytest
+pycparser==2.23
+    # via cffi
+pygithub==2.8.1
+    # via -r requirements.in
 pygments==2.19.2
     # via pytest
+pyjwt[crypto]==2.10.1
+    # via pygithub
+pynacl==1.6.0
+    # via pygithub
 pytest==8.4.2
     # via -r requirements.in
-requests==2.32.5
+pyyaml==6.0.2
     # via -r requirements.in
+requests==2.32.5
+    # via
+    #   -r requirements.in
+    #   pygithub
 soupsieve==2.8
     # via beautifulsoup4
 typing-extensions==4.15.0
-    # via beautifulsoup4
+    # via
+    #   beautifulsoup4
+    #   pygithub
 urllib3==2.5.0
-    # via requests
+    # via
+    #   pygithub
+    #   requests

scripts/update-nbviewer.py

@@ -0,0 +1,105 @@
+"""
+script to update nbviewer
+
+run via watch-dependencies.yaml workflow,
+but can be run locally.
+
+"""
+
+import os
+import shlex
+from pathlib import Path
+from subprocess import check_output
+
+import requests
+import yaml
+
+nbviewer_deploy = Path(__file__).absolute().parents[1]
+cd_yaml = nbviewer_deploy / ".github/workflows/cd.yml"
+nbviewer_config_yaml = nbviewer_deploy / "config/nbviewer.yaml"
+
+
+def _maybe_output(key, value):
+    """Make outputs available to github actions (if running in github actions)"""
+    github_output = os.environ.get("GITHUB_OUTPUT")
+    line = f"{key}={shlex.quote(value)}"
+    if github_output:
+        with Path(github_output).open("a") as f:
+            f.write(f"{line}\n")
+    else:
+        print(line)
+
+
+def get_current_chart():
+    """Get the current version of the chart in cd.yaml"""
+    with cd_yaml.open() as f:
+        cd = yaml.safe_load(f)
+    chart_rev = cd["env"]["NBVIEWER_VERSION"]
+    return chart_rev
+
+
+def get_latest_chart():
+    """Get the latest version of the chart repo"""
+    out = check_output(
+        ["git", "ls-remote", "https://github.com/jupyter/nbviewer", "HEAD"], text=True
+    ).strip()
+    return out.split()[0]
+
+
+def get_current_image():
+    """Get the current version of the nbviewer image in config"""
+    with nbviewer_config_yaml.open() as f:
+        config = yaml.safe_load(f)
+    current_image = config["image"]
+    return current_image
+
+
+def get_latest_image():
+    """Get the latest version of the nbviewer image from docker hub"""
+    r = requests.get("https://hub.docker.com/v2/repositories/jupyter/nbviewer/tags")
+    r.raise_for_status()
+    tags = r.json()
+    tag = tags["results"][0]["name"]
+    return f"jupyter/nbviewer:{tag}"
+
+
+def update_chart():
+    """Update the version of the nbviewer chart to be deployed"""
+    current_chart = get_current_chart()
+    latest_chart = get_latest_chart()
+    _maybe_output("chart_before", current_chart)
+    _maybe_output("chart_after", latest_chart)
+    _maybe_output("chart_short", latest_chart[:7])
+    if latest_chart != current_chart:
+        print(f"Updating {current_chart} -> {latest_chart} in {cd_yaml}")
+        with cd_yaml.open() as f:
+            current_yaml = f.read()
+        modified_yaml = current_yaml.replace(current_chart, latest_chart, 1)
+        with cd_yaml.open("w") as f:
+            f.write(modified_yaml)
+
+
+def update_image():
+    """Update the version of the nbviewer image to be deployed"""
+    current_image = get_current_image()
+    latest_image = get_latest_image()
+    _maybe_output("image_before", current_image)
+    _maybe_output("image_after", latest_image)
+    _maybe_output("image_tag", latest_image.partition(":")[2])
+
+    if latest_image != current_image:
+        print(f"Updating {current_image} -> {latest_image} in {nbviewer_config_yaml}")
+        with nbviewer_config_yaml.open() as f:
+            current_yaml = f.read()
+        modified_yaml = current_yaml.replace(current_image, latest_image, 1)
+        with nbviewer_config_yaml.open("w") as f:
+            f.write(modified_yaml)
+
+
+def main():
+    update_chart()
+    update_image()
+
+
+if __name__ == "__main__":
+    main()