ecr input to specify whether the given registry is ECR

crazy-max · crazy-max · commit b9a4d91ee516 · 2021-12-20T10:59:20.000+01:00
Signed-off-by: CrazyMax &lt;crazy-max@users.noreply.github.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,7 +3,7 @@ name: ci
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 10 * * *' # everyday at 10am
+    - cron: '0 10 * * *'
   push:
     branches:
       - 'master'
diff --git a/README.md b/README.md
@@ -379,6 +379,7 @@ Following inputs can be used as `step.with` keys
 | `registry`       | String  |                             | Server address of Docker registry. If not set then will default to Docker Hub |
 | `username`       | String  |                             | Username used to log against the Docker registry |
 | `password`       | String  |                             | Password or personal access token used to log against the Docker registry |
+| `ecr`            | String  | `auto`                      | Specifies whether the given registry is ECR (`auto`, `true` or `false`) |
 | `logout`         | Bool    | `true`                      | Log out from the Docker registry at the end of a job |
 
 ## Keep up-to-date with GitHub Dependabot
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -34,14 +34,17 @@ test('successful with username and password', async () => {
   const password: string = 'groundcontrol';
   process.env[`INPUT_PASSWORD`] = password;
 
+  const ecr: string = 'auto';
+  process.env['INPUT_ECR'] = ecr;
+
   const logout: boolean = false;
   process.env['INPUT_LOGOUT'] = String(logout);
 
   await run();
 
   expect(setRegistrySpy).toHaveBeenCalledWith('');
   expect(setLogoutSpy).toHaveBeenCalledWith(logout);
-  expect(dockerSpy).toHaveBeenCalledWith('', username, password);
+  expect(dockerSpy).toHaveBeenCalledWith('', username, password, ecr);
 });
 
 test('calls docker login', async () => {
@@ -62,12 +65,15 @@ test('calls docker login', async () => {
   const registry: string = 'ghcr.io';
   process.env[`INPUT_REGISTRY`] = registry;
 
+  const ecr: string = 'auto';
+  process.env['INPUT_ECR'] = ecr;
+
   const logout: boolean = true;
   process.env['INPUT_LOGOUT'] = String(logout);
 
   await run();
 
   expect(setRegistrySpy).toHaveBeenCalledWith(registry);
   expect(setLogoutSpy).toHaveBeenCalledWith(logout);
-  expect(dockerSpy).toHaveBeenCalledWith(registry, username, password);
+  expect(dockerSpy).toHaveBeenCalledWith(registry, username, password, ecr);
 });
diff --git a/action.yml b/action.yml
@@ -16,6 +16,10 @@ inputs:
   password:
     description: 'Password or personal access token used to log against the Docker registry'
     required: false
+  ecr:
+    description: 'Specifies whether the given registry is ECR (auto, true or false)'
+    default: 'auto'
+    required: false
   logout:
     description: 'Log out from the Docker registry at the end of a job'
     default: 'true'
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/context.ts b/src/context.ts
@@ -4,6 +4,7 @@ export interface Inputs {
   registry: string;
   username: string;
   password: string;
+  ecr: string;
   logout: boolean;
 }
 
@@ -12,6 +13,7 @@ export function getInputs(): Inputs {
     registry: core.getInput('registry'),
     username: core.getInput('username'),
     password: core.getInput('password'),
+    ecr: core.getInput('ecr'),
     logout: core.getBooleanInput('logout')
   };
 }
diff --git a/src/docker.ts b/src/docker.ts
@@ -2,8 +2,8 @@ import * as aws from './aws';
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 
-export async function login(registry: string, username: string, password: string): Promise<void> {
-  if (aws.isECR(registry)) {
+export async function login(registry: string, username: string, password: string, ecr: string): Promise<void> {
+  if (/true/i.test(ecr) || (ecr == 'auto' && aws.isECR(registry))) {
     await loginECR(registry, username, password);
   } else {
     await loginStandard(registry, username, password);
diff --git a/src/main.ts b/src/main.ts
@@ -5,10 +5,10 @@ import * as stateHelper from './state-helper';
 
 export async function run(): Promise<void> {
   try {
-    const {registry, username, password, logout} = context.getInputs();
-    stateHelper.setRegistry(registry);
-    stateHelper.setLogout(logout);
-    await docker.login(registry, username, password);
+    const input: context.Inputs = context.getInputs();
+    stateHelper.setRegistry(input.registry);
+    stateHelper.setLogout(input.logout);
+    await docker.login(input.registry, input.username, input.password, input.ecr);
   } catch (error) {
     core.setFailed(error.message);
   }

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ export interface Inputs {`
`4`	`4`	`registry: string;`
`5`	`5`	`username: string;`
`6`	`6`	`password: string;`
	`7`	`+ ecr: string;`
`7`	`8`	`logout: boolean;`
`8`	`9`	`}`
`9`	`10`
`@@ -12,6 +13,7 @@ export function getInputs(): Inputs {`
`12`	`13`	`registry: core.getInput('registry'),`
`13`	`14`	`username: core.getInput('username'),`
`14`	`15`	`password: core.getInput('password'),`
	`16`	`+ ecr: core.getInput('ecr'),`
`15`	`17`	`logout: core.getBooleanInput('logout')`
`16`	`18`	`};`
`17`	`19`	`}`