basehub: add comments about chartpress

consideRatio · Aug 26, 2021 · d8b4fa9 · d8b4fa9
1 parent 7522915
commit d8b4fa9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/hub-templates/basehub/Chart.yaml b/hub-templates/basehub/Chart.yaml
@@ -5,6 +5,9 @@ name: basehub
 version: "0.0.1-n1159.h5b045cd"
 dependencies:
   - name: jupyterhub
-    # REMEMBER TO CHANGE BASE IMAGE OF images/hub/ WHEN CHANGING THIS
+    # Updates to this version should follow go hand in hand with updates to
+    # images/hub/Dockerfile, and will also involve manually building and pushing
+    # the Dockerfile to https://quay.io/2i2c/pilot-hub. Details about this can
+    # be found in the Dockerfile's comments.
     version: 1.1.3
     repository: https://jupyterhub.github.io/helm-chart/
diff --git a/hub-templates/images/hub/Dockerfile b/hub-templates/images/hub/Dockerfile
@@ -1,5 +1,11 @@
-# Should match the hub image used by version of chart in hub/requirements.yaml
-# If that changes, this should be changed too!
+# This image tag should match the dependent JupyterHub Helm chart's version as
+# declared in basehub/Chart.yaml.
+#
+# If you make an update to this tag and the JupyterHub Helm chart's version,
+# then commit those changes and then perform `chartpress --push` with your
+# quay.io container registry credentials configured to have access to
+# https://quay.io/repository/2i2c/pilot-hub.
+#
 FROM jupyterhub/k8s-hub:1.1.3
 
 ENV CONFIGURATOR_VERSION ed7e3a0df1e3d625d10903ef7d7fd9c2fbb548db