Warn the usage of dockerImageRegistry (#737)

tinglesoftware · Aug 8, 2023 · 9433a70 · 9433a70
1 parent a0bfd5c
commit 9433a70
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/extension/task/index.ts b/extension/task/index.ts
@@ -221,12 +221,27 @@ async function run() {
         dockerRunner.arg(['--mount', `type=bind,source=/ssh-agent,target=/ssh-agent`]);
       }
 
+      let dockerImageRegistry = variables.dockerImageRegistry;
+      if (variables.dockerImageRegistry) {
+        if (dockerImageRegistry !== 'ghcr.io') { // skip known default value
+          tl.warning(
+            `
+          You supplied the dockerImageRegistry input but it is set to be removed.
+          \n
+          If you have a compelling enough reason why it should be retained, air your views
+          at https://github.com/tinglesoftware/dependabot-azure-devops/issues/736
+          \n
+          Do this before Monday, 11 September, 2023 when we intend to throw errors if the input is set or ignore it altogether.
+          `);
+        }
+      } else {
+        dockerImageRegistry = 'ghcr.io';
+      }
+
       // Form the docker image based on the ecosystem (repository) and the tag e.g. tinglesoftware/dependabot-updater-nuget
       // For custom/enterprise registries, prefix with the registry, e.g. contoso.azurecr.io/tinglesoftware/dependabot-updater-nuget
       let dockerImage: string = `tinglesoftware/dependabot-updater-${update.packageEcosystem}:${variables.dockerImageTag}`
-      if (variables.dockerImageRegistry) {
-        dockerImage = `${variables.dockerImageRegistry}/${dockerImage}`.replace("//", "/");
-      }
+      dockerImage = `${dockerImageRegistry}/${dockerImage}`.replace("//", "/");
 
       tl.debug(`Running docker container -> '${dockerImage}' ...`);
       dockerRunner.arg(dockerImage);

diff --git a/extension/task/task.json b/extension/task/task.json
@@ -213,7 +213,6 @@
       "label": "Container registry override",
       "groupName": "advanced",
       "helpMarkDown": "The docker registry to use when pulling the docker container used by the task if needed. By default this will use GHCR. This can be useful if the container needs to come from an internal docker registry mirror or alternative source for testing. If the mirror requires authentication add a `docker login` task before this task. Example: `contoso.azurecr.io`",
-      "defaultValue": "ghcr.io",
       "required": false
     },
     {

diff --git a/extension/task/utils/getSharedVariables.ts b/extension/task/utils/getSharedVariables.ts
@@ -143,9 +143,7 @@ export default function getSharedVariables(): ISharedVariables {
   );
 
   // Prepare variables for the docker image to use
-  let dockerImageRegistry: string | undefined = tl.getInput(
-    "dockerImageRegistry"
-  );
+  let dockerImageRegistry: string | undefined = tl.getInput("dockerImageRegistry");
   let dockerImageTag: string = getDockerImageTag();
 
   return {