Sfoglia il codice sorgente

contrib: outline purpose of download-frozen-images-v2.sh

We occassionally receive contributions to this script that are outside
its intended scope. Let's add a comment to the script that outlines
what it's meant for, and a link to a GitHub ticket with alternatives.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 1 anno fa
parent
commit
14c5f7bf1d
1 ha cambiato i file con 13 aggiunte e 0 eliminazioni
  1. 13 0
      contrib/download-frozen-image-v2.sh

+ 13 - 0
contrib/download-frozen-image-v2.sh

@@ -1,6 +1,19 @@
 #!/usr/bin/env bash
 #!/usr/bin/env bash
 set -eo pipefail
 set -eo pipefail
 
 
+# This script was developed for use in Moby's CI, and as such the use cases and
+# usability are (intentionally) limited. You may find this script useful for
+# educational purposes, for example, to learn how pulling images works "under
+# the hood", and you may be able to use it for other purposes, but it should not
+# be considered a "general purpose" tool for pulling images.
+#
+# The project maintainers accept contributions to this script within its intended
+# scope, but may not accept contributions beyond that.
+#
+# For users who have a similar need but require more flexibility/functionality,
+# refer the the discussion on GitHub, which mentions various alternatives that
+# are more suitable for other uses: https://github.com/moby/moby/issues/40857
+
 # hello-world                      latest              ef872312fe1b        3 months ago        910 B
 # hello-world                      latest              ef872312fe1b        3 months ago        910 B
 # hello-world                      latest              ef872312fe1bbc5e05aae626791a47ee9b032efa8f3bda39cc0be7b56bfe59b9   3 months ago        910 B
 # hello-world                      latest              ef872312fe1bbc5e05aae626791a47ee9b032efa8f3bda39cc0be7b56bfe59b9   3 months ago        910 B