Merge pull request #599 from docker/dependabot/npm_and_yarn/aws-sdk-dependencies-44d897a124

build(deps): bump the aws-sdk-dependencies group with 2 updates

.eslintignore

@@ -0,0 +1,3 @@
+/dist/**
+/coverage/**
+/node_modules/**

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+  "env": {
+    "node": true,
+    "es6": true,
+    "jest": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jest",
+    "prettier"
+  ]
+}

.github/CODEOWNERS

@@ -1 +0,0 @@
-*	@crazy-max

.github/dependabot.yml

@@ -11,6 +11,14 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    versioning-strategy: "increase"
+    groups:
+      aws-sdk-dependencies:
+        patterns:
+          - "*aws-sdk*"
+      proxy-agent-dependencies:
+        patterns:
+          - "*-proxy-agent"
     allow:
       - dependency-type: "production"
     labels:

.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: ci
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   workflow_dispatch:
   schedule:
@@ -15,7 +19,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Stop docker
         run: |
@@ -39,7 +43,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to GitHub Container Registry
         uses: ./
@@ -56,7 +60,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to GitHub Container Registry
         uses: ./
@@ -76,6 +80,20 @@ jobs:
           docker image prune -a -f >/dev/null 2>&1
           docker pull ghcr.io/docker-ghactiontest/test
 
+  acr:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Login to ACR
+        uses: ./
+        with:
+          registry: ${{ secrets.AZURE_REGISTRY_NAME }}.azurecr.io
+          username: ${{ secrets.AZURE_CLIENT_ID }}
+          password: ${{ secrets.AZURE_CLIENT_SECRET }}
+
   dockerhub:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -87,7 +105,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to Docker Hub
         uses: ./
@@ -106,7 +124,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to ECR
         uses: ./
@@ -126,10 +144,10 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -151,7 +169,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to Public ECR
         uses: ./
@@ -173,10 +191,10 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -198,7 +216,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to GitHub Container Registry
         uses: ./
@@ -218,7 +236,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to GitLab
         uses: ./
@@ -238,7 +256,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to Google Artifact Registry
         uses: ./
@@ -258,7 +276,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       -
         name: Login to Google Container Registry
         uses: ./

.github/workflows/test.yml

@@ -1,14 +1,15 @@
 name: test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
       - 'master'
       - 'releases/v*'
   pull_request:
-    branches:
-      - 'master'
-      - 'releases/v*'
 
 jobs:
   test:
@@ -16,19 +17,14 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
-      -
-        name: Validate
-        uses: docker/bake-action@v1
-        with:
-          targets: validate
+        uses: actions/checkout@v4
       -
         name: Test
-        uses: docker/bake-action@v1
+        uses: docker/bake-action@v3
         with:
           targets: test
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           file: ./coverage/clover.xml

.github/workflows/validate.yml

@@ -0,0 +1,45 @@
+name: validate
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'releases/v*'
+  pull_request:
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      targets: ${{ steps.targets.outputs.matrix }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Targets matrix
+        id: targets
+        run: |
+          echo "matrix=$(docker buildx bake validate --print | jq -cr '.group.validate.targets')" >> $GITHUB_OUTPUT
+
+  validate:
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJson(needs.prepare.outputs.targets) }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Validate
+        uses: docker/bake-action@v3
+        with:
+          targets: ${{ matrix.target }}

.gitignore

@@ -1,11 +1,6 @@
-/.dev
 node_modules/
 lib
 
-# Jetbrains
-/.idea
-/*.iml
-
 # Rest of the file pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
 logs

README.md

@@ -1,7 +1,7 @@
 [![GitHub release](https://img.shields.io/github/release/docker/login-action.svg?style=flat-square)](https://github.com/docker/login-action/releases/latest)
 [![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--login-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-login)
-[![CI workflow](https://img.shields.io/github/workflow/status/docker/login-action/ci?label=ci&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=ci)
-[![Test workflow](https://img.shields.io/github/workflow/status/docker/login-action/test?label=test&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=test)
+[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/login-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=ci)
+[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/login-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=test)
 [![Codecov](https://img.shields.io/codecov/c/github/docker/login-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/login-action)
 
 ## About
@@ -39,7 +39,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -47,7 +47,7 @@ jobs:
     steps:
       -
         name: Login to Docker Hub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -64,7 +64,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -72,7 +72,7 @@ jobs:
     steps:
       -
         name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -92,7 +92,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -100,13 +100,15 @@ jobs:
     steps:
       -
         name: Login to GitLab
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: registry.gitlab.com
           username: ${{ secrets.GITLAB_USERNAME }}
           password: ${{ secrets.GITLAB_PASSWORD }}
 ```
 
+If you have [Two-Factor Authentication](https://gitlab.com/help/user/profile/account/two_factor_authentication) enabled, use a [Personal Access Token](https://gitlab.com/help/user/profile/personal_access_tokens) instead of a password.
+
 ### Azure Container Registry (ACR)
 
 [Create a service principal](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-auth-service-principal#create-a-service-principal)
@@ -118,7 +120,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -126,7 +128,7 @@ jobs:
     steps:
       -
         name: Login to ACR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <registry-name>.azurecr.io
           username: ${{ secrets.AZURE_CLIENT_ID }}
@@ -142,6 +144,45 @@ jobs:
 > Google Container Registry, use the information [on this page](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr)
 > to learn about transitioning to Google Artifact Registry. 
 
+You can use either workload identity federation based keyless authentication or service account based authentication.
+
+#### Workload identity federation based authentication
+
+Configure the workload identity federation for github actions in gcloud (for steps, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)). In the steps, your service account should the ability to push to GCR. Then use google-github-actions/auth action for authentication using workload identity like below:
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: main
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+    - id: 'auth'
+      name: 'Authenticate to Google Cloud'
+      uses: 'google-github-actions/auth@v0'
+      with:
+        token_format: 'access_token'
+        workload_identity_provider: '<workload_identity_provider>'
+        service_account: '<service_account>'
+
+    - name: Login to GCR
+      uses: docker/login-action@v2
+      with:
+        registry: gcr.io
+        username: oauth2accesstoken
+        password: ${{ steps.auth.outputs.access_token }}
+```
+
+> Replace `<workload_identity_provider>` with configured workload identity provider. For steps to configure, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation).
+
+> Replace `<service_account>` with configured service account in workload identity provider which has access to push to GCR
+
+#### Service account based authentication
+
 Use a service account with the ability to push to GCR and [configure access control](https://cloud.google.com/container-registry/docs/access-control).
 Then create and download the JSON key for this service account and save content of `.json` file
 [as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -153,7 +194,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -161,7 +202,7 @@ jobs:
     steps:
       -
         name: Login to GCR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: gcr.io
           username: _json_key
@@ -170,6 +211,47 @@ jobs:
 
 ### Google Artifact Registry (GAR)
 
+You can use either workload identity federation based keyless authentication or  service account based authentication.
+
+#### Workload identity federation based authentication
+
+Configure the workload identity federation for github actions in gcloud (for steps, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)). In the steps, your service account should the ability to push to GAR. Then use google-github-actions/auth action for authentication using workload identity like below:
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: main
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      - id: 'auth'
+        name: 'Authenticate to Google Cloud'
+        uses: 'google-github-actions/auth@v0'
+        with:
+          token_format: 'access_token'
+          workload_identity_provider: '<workload_identity_provider>'
+          service_account: '<service_account>'
+      
+      - name: Login to GAR
+        uses: docker/login-action@v2
+        with:
+          registry: <location>-docker.pkg.dev
+          username: oauth2accesstoken
+          password: ${{ steps.auth.outputs.access_token }}
+```
+> Replace `<workload_identity_provider>` with configured workload identity provider
+
+> Replace `<service_account>` with configured service account in workload identity provider which has access to push to GCR
+
+> Replace `<location>` with the regional or multi-regional [location](https://cloud.google.com/artifact-registry/docs/repo-organize#locations)
+> of the repository where the image is stored.
+
+#### Service account based authentication
+
 Use a service account with the ability to push to GAR and [configure access control](https://cloud.google.com/artifact-registry/docs/access-control).
 Then create and download the JSON key for this service account and save content of `.json` file
 [as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -181,7 +263,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -189,7 +271,7 @@ jobs:
     steps:
       -
         name: Login to GAR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <location>-docker.pkg.dev
           username: _json_key
@@ -210,7 +292,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -218,7 +300,7 @@ jobs:
     steps:
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -233,7 +315,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -241,7 +323,7 @@ jobs:
     steps:
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -260,7 +342,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -275,7 +357,7 @@ jobs:
           aws-region: <region>
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
 ```
@@ -293,7 +375,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -301,7 +383,7 @@ jobs:
     steps:
       -
         name: Login to Public ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: public.ecr.aws
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -327,7 +409,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -335,7 +417,7 @@ jobs:
     steps:
       -
         name: Login to OCIR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <region>.ocir.io
           username: ${{ secrets.OCI_USERNAME }}
@@ -353,7 +435,7 @@ name: ci
 
 on:
   push:
-    branches: master
+    branches: main
 
 jobs:
   login:
@@ -361,7 +443,7 @@ jobs:
     steps:
       -
         name: Login to Quay.io
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: quay.io
           username: ${{ secrets.QUAY_USERNAME }}

__tests__/aws.test.ts

@@ -1,4 +1,6 @@
+import {beforeEach, describe, expect, jest, test} from '@jest/globals';
 import {AuthorizationData} from '@aws-sdk/client-ecr';
+
 import * as aws from '../src/aws';
 
 describe('isECR', () => {

__tests__/context.test.ts

@@ -1,3 +1,5 @@
+import {expect, test} from '@jest/globals';
+
 import {getInputs} from '../src/context';
 
 test('with password and username getInputs does not throw error', async () => {
@@ -6,5 +8,5 @@ test('with password and username getInputs does not throw error', async () => {
   process.env['INPUT_LOGOUT'] = 'true';
   expect(() => {
     getInputs();
-  }).not.toThrowError();
+  }).not.toThrow();
 });

__tests__/docker.test.ts

@@ -1,24 +1,25 @@
-import {loginStandard, logout} from '../src/docker';
-
+import {expect, jest, test} from '@jest/globals';
 import * as path from 'path';
 
-import * as exec from '@actions/exec';
+import {loginStandard, logout} from '../src/docker';
+import {Exec} from '@docker/actions-toolkit/lib/exec';
 
 process.env['RUNNER_TEMP'] = path.join(__dirname, 'runner');
 
 test('loginStandard calls exec', async () => {
-  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'getExecOutput');
-  execSpy.mockImplementation(() =>
-    Promise.resolve({
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const execSpy = jest.spyOn(Exec, 'getExecOutput').mockImplementation(async () => {
+    return {
       exitCode: expect.any(Number),
       stdout: expect.any(Function),
       stderr: expect.any(Function)
-    })
-  );
+    };
+  });
 
-  const username: string = 'dbowie';
-  const password: string = 'groundcontrol';
-  const registry: string = 'https://ghcr.io';
+  const username = 'dbowie';
+  const password = 'groundcontrol';
+  const registry = 'https://ghcr.io';
 
   await loginStandard(registry, username, password);
 
@@ -30,16 +31,17 @@ test('loginStandard calls exec', async () => {
 });
 
 test('logout calls exec', async () => {
-  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'getExecOutput');
-  execSpy.mockImplementation(() =>
-    Promise.resolve({
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const execSpy = jest.spyOn(Exec, 'getExecOutput').mockImplementation(async () => {
+    return {
       exitCode: expect.any(Number),
       stdout: expect.any(Function),
       stderr: expect.any(Function)
-    })
-  );
+    };
+  });
 
-  const registry: string = 'https://ghcr.io';
+  const registry = 'https://ghcr.io';
 
   await logout(registry);
 

__tests__/main.test.ts

@@ -1,79 +0,0 @@
-import osm = require('os');
-
-import {run} from '../src/main';
-import * as docker from '../src/docker';
-import * as stateHelper from '../src/state-helper';
-
-import * as core from '@actions/core';
-
-test('errors without username and password', async () => {
-  const platSpy = jest.spyOn(osm, 'platform');
-  platSpy.mockImplementation(() => 'linux');
-
-  process.env['INPUT_LOGOUT'] = 'true'; // default value
-
-  const coreSpy: jest.SpyInstance = jest.spyOn(core, 'setFailed');
-
-  await run();
-
-  expect(coreSpy).toHaveBeenCalledWith('Username and password required');
-});
-
-test('successful with username and password', async () => {
-  const platSpy = jest.spyOn(osm, 'platform');
-  platSpy.mockImplementation(() => 'linux');
-
-  const setRegistrySpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setRegistry');
-  const setLogoutSpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setLogout');
-  const dockerSpy: jest.SpyInstance = jest.spyOn(docker, 'login');
-  dockerSpy.mockImplementation(() => {});
-
-  const username: string = 'dbowie';
-  process.env[`INPUT_USERNAME`] = username;
-
-  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, ecr);
-});
-
-test('calls docker login', async () => {
-  const platSpy = jest.spyOn(osm, 'platform');
-  platSpy.mockImplementation(() => 'linux');
-
-  const setRegistrySpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setRegistry');
-  const setLogoutSpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setLogout');
-  const dockerSpy: jest.SpyInstance = jest.spyOn(docker, 'login');
-  dockerSpy.mockImplementation(() => {});
-
-  const username: string = 'dbowie';
-  process.env[`INPUT_USERNAME`] = username;
-
-  const password: string = 'groundcontrol';
-  process.env[`INPUT_PASSWORD`] = password;
-
-  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, ecr);
-});

action.yml

@@ -26,6 +26,6 @@ inputs:
     required: false
 
 runs:
-  using: 'node12'
+  using: 'node20'
   main: 'dist/index.js'
   post: 'dist/index.js'

dev.Dockerfile

@@ -1,8 +1,6 @@
-# syntax=docker/dockerfile:1.3-labs
+# syntax=docker/dockerfile:1
 
-ARG NODE_VERSION
-ARG DOCKER_VERSION=20.10.10
-ARG BUILDX_VERSION=0.7.0
+ARG NODE_VERSION=20
 
 FROM node:${NODE_VERSION}-alpine AS base
 RUN apk add --no-cache cpio findutils git
@@ -18,14 +16,14 @@ COPY --from=deps /vendor /
 
 FROM deps AS vendor-validate
 RUN --mount=type=bind,target=.,rw <<EOT
-set -e
-git add -A
-cp -rf /vendor/* .
-if [ -n "$(git status --porcelain -- yarn.lock)" ]; then
-  echo >&2 'ERROR: Vendor result differs. Please vendor your package with "docker buildx bake vendor-update"'
-  git status --porcelain -- yarn.lock
-  exit 1
-fi
+  set -e
+  git add -A
+  cp -rf /vendor/* .
+  if [ -n "$(git status --porcelain -- yarn.lock)" ]; then
+    echo >&2 'ERROR: Vendor result differs. Please vendor your package with "docker buildx bake vendor-update"'
+    git status --porcelain -- yarn.lock
+    exit 1
+  fi
 EOT
 
 FROM deps AS build
@@ -38,14 +36,14 @@ COPY --from=build /out /
 
 FROM build AS build-validate
 RUN --mount=type=bind,target=.,rw <<EOT
-set -e
-git add -A
-cp -rf /out/* .
-if [ -n "$(git status --porcelain -- dist)" ]; then
-  echo >&2 'ERROR: Build result differs. Please build first with "docker buildx bake build"'
-  git status --porcelain -- dist
-  exit 1
-fi
+  set -e
+  git add -A
+  cp -rf /out/* .
+  if [ -n "$(git status --porcelain -- dist)" ]; then
+    echo >&2 'ERROR: Build result differs. Please build first with "docker buildx bake build"'
+    git status --porcelain -- dist
+    exit 1
+  fi
 EOT
 
 FROM deps AS format
@@ -57,22 +55,17 @@ RUN --mount=type=bind,target=.,rw \
 FROM scratch AS format-update
 COPY --from=format /out /
 
-FROM deps AS format-validate
+FROM deps AS lint
 RUN --mount=type=bind,target=.,rw \
   --mount=type=cache,target=/src/node_modules \
-  yarn run format-check
-
-FROM docker:${DOCKER_VERSION} as docker
-FROM docker/buildx-bin:${BUILDX_VERSION} as buildx
+  yarn run lint
 
 FROM deps AS test
 ENV RUNNER_TEMP=/tmp/github_runner
 ENV RUNNER_TOOL_CACHE=/tmp/github_tool_cache
 RUN --mount=type=bind,target=.,rw \
   --mount=type=cache,target=/src/node_modules \
-  --mount=type=bind,from=docker,source=/usr/local/bin/docker,target=/usr/bin/docker \
-  --mount=type=bind,from=buildx,source=/buildx,target=/usr/libexec/docker/cli-plugins/docker-buildx \
-  yarn run test --coverageDirectory=/tmp/coverage
+  yarn run test --coverage --coverageDirectory=/tmp/coverage
 
 FROM scratch AS test-coverage
 COPY --from=test /tmp/coverage /

docker-bake.hcl

@@ -1,13 +1,3 @@
-variable "NODE_VERSION" {
-  default = "12"
-}
-
-target "node-version" {
-  args = {
-    NODE_VERSION = NODE_VERSION
-  }
-}
-
 group "default" {
   targets = ["build"]
 }
@@ -17,54 +7,47 @@ group "pre-checkin" {
 }
 
 group "validate" {
-  targets = ["format-validate", "build-validate", "vendor-validate"]
+  targets = ["lint", "build-validate", "vendor-validate"]
 }
 
 target "build" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "build-update"
   output = ["."]
 }
 
 target "build-validate" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "build-validate"
   output = ["type=cacheonly"]
 }
 
 target "format" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "format-update"
   output = ["."]
 }
 
-target "format-validate" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
-  target = "format-validate"
+target "lint" {
+  dockerfile = "dev.Dockerfile"
+  target = "lint"
   output = ["type=cacheonly"]
 }
 
 target "vendor-update" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "vendor-update"
   output = ["."]
 }
 
 target "vendor-validate" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "vendor-validate"
   output = ["type=cacheonly"]
 }
 
 target "test" {
-  inherits = ["node-version"]
-  dockerfile = "./hack/build.Dockerfile"
+  dockerfile = "dev.Dockerfile"
   target = "test-coverage"
   output = ["./coverage"]
 }

jest.config.js

@@ -1,12 +0,0 @@
-module.exports = {
-  clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
-  setupFiles: ["dotenv/config"],
-  testEnvironment: 'node',
-  testMatch: ['**/*.test.ts'],
-  testRunner: 'jest-circus/runner',
-  transform: {
-    '^.+\\.ts$': 'ts-jest'
-  },
-  verbose: false
-}

jest.config.ts

@@ -0,0 +1,30 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-login-action-')).split(path.sep).join(path.posix.sep);
+
+process.env = Object.assign({}, process.env, {
+  TEMP: tmpDir,
+  GITHUB_REPOSITORY: 'docker/login-action',
+  RUNNER_TEMP: path.join(tmpDir, 'runner-temp').split(path.sep).join(path.posix.sep),
+  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache').split(path.sep).join(path.posix.sep)
+}) as {
+  [key: string]: string;
+};
+
+module.exports = {
+  clearMocks: true,
+  testEnvironment: 'node',
+  moduleFileExtensions: ['js', 'ts'],
+  testMatch: ['**/*.test.ts'],
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  moduleNameMapper: {
+    '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
+  },
+  collectCoverageFrom: ['src/**/{!(main.ts),}.ts'],
+  coveragePathIgnorePatterns: ['lib/', 'node_modules/', '__tests__/'],
+  verbose: true
+};

package.json

@@ -3,11 +3,15 @@
   "description": "GitHub Action to login against a Docker registry",
   "main": "lib/main.js",
   "scripts": {
-    "build": "tsc && ncc build",
-    "format": "prettier --write **/*.ts",
-    "format-check": "prettier --check **/*.ts",
-    "test": "jest --coverage",
-    "pre-checkin": "yarn run format && yarn run build"
+    "build": "ncc build src/main.ts --source-map --minify --license licenses.txt",
+    "lint": "yarn run prettier && yarn run eslint",
+    "format": "yarn run prettier:fix && yarn run eslint:fix",
+    "eslint": "eslint --max-warnings=0 .",
+    "eslint:fix": "eslint --fix .",
+    "prettier": "prettier --check \"./**/*.ts\"",
+    "prettier:fix": "prettier --write \"./**/*.ts\"",
+    "test": "jest",
+    "all": "yarn run build && yarn run format && yarn test"
   },
   "repository": {
     "type": "git",
@@ -18,32 +22,29 @@
     "docker",
     "login"
   ],
-  "author": "Docker",
-  "contributors": [
-    {
-      "name": "CrazyMax",
-      "url": "https://crazymax.dev"
-    }
-  ],
-  "license": "MIT",
+  "author": "Docker Inc.",
+  "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/exec": "^1.1.0",
-    "@actions/io": "^1.1.1",
-    "@aws-sdk/client-ecr": "^3.44.0",
-    "@aws-sdk/client-ecr-public": "^3.43.0"
+    "@actions/core": "^1.10.1",
+    "@aws-sdk/client-ecr": "^3.410.0",
+    "@aws-sdk/client-ecr-public": "^3.410.0",
+    "@docker/actions-toolkit": "^0.12.0",
+    "http-proxy-agent": "^7.0.0",
+    "https-proxy-agent": "^7.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
-    "@types/node": "^14.17.4",
-    "@vercel/ncc": "^0.28.6",
-    "dotenv": "^8.6.0",
-    "jest": "^26.6.3",
-    "jest-circus": "^26.6.3",
-    "jest-runtime": "^26.6.3",
-    "prettier": "^2.3.2",
-    "ts-jest": "^26.5.6",
-    "typescript": "^3.9.10",
-    "typescript-formatter": "^7.2.2"
+    "@types/node": "^20.5.9",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "@vercel/ncc": "^0.38.0",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.4",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   }
 }

src/aws.ts

@@ -1,6 +1,9 @@
 import * as core from '@actions/core';
 import {ECR} from '@aws-sdk/client-ecr';
 import {ECRPUBLIC} from '@aws-sdk/client-ecr-public';
+import {NodeHttpHandler} from '@smithy/node-http-handler';
+import {HttpProxyAgent} from 'http-proxy-agent';
+import {HttpsProxyAgent} from 'https-proxy-agent';
 
 const ecrRegistryRegex = /^(([0-9]{12})\.dkr\.ecr\.(.+)\.amazonaws\.com(.cn)?)(\/([^:]+)(:.+)?)?$/;
 
@@ -31,7 +34,7 @@ export const getAccountIDs = (registry: string): string[] => {
   if (!matches) {
     return [];
   }
-  let accountIDs: Array<string> = [matches[2]];
+  const accountIDs: Array<string> = [matches[2]];
   if (process.env.AWS_ACCOUNT_IDS) {
     accountIDs.push(...process.env.AWS_ACCOUNT_IDS.split(','));
   }
@@ -54,6 +57,20 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     authTokenRequest['registryIds'] = accountIDs;
   }
 
+  let httpProxyAgent;
+  const httpProxy = process.env.http_proxy || process.env.HTTP_PROXY || '';
+  if (httpProxy) {
+    core.debug(`Using http proxy ${httpProxy}`);
+    httpProxyAgent = new HttpProxyAgent(httpProxy);
+  }
+
+  let httpsProxyAgent;
+  const httpsProxy = process.env.https_proxy || process.env.HTTPS_PROXY || '';
+  if (httpsProxy) {
+    core.debug(`Using https proxy ${httpsProxy}`);
+    httpsProxyAgent = new HttpsProxyAgent(httpsProxy);
+  }
+
   const credentials =
     username && password
       ? {
@@ -67,7 +84,11 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     const ecrPublic = new ECRPUBLIC({
       customUserAgent: 'docker-login-action',
       credentials,
-      region: region
+      region: region,
+      requestHandler: new NodeHttpHandler({
+        httpAgent: httpProxyAgent,
+        httpsAgent: httpsProxyAgent
+      })
     });
     const authTokenResponse = await ecrPublic.getAuthorizationToken(authTokenRequest);
     if (!authTokenResponse.authorizationData || !authTokenResponse.authorizationData.authorizationToken) {
@@ -75,6 +96,8 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     }
     const authToken = Buffer.from(authTokenResponse.authorizationData.authorizationToken, 'base64').toString('utf-8');
     const creds = authToken.split(':', 2);
+    core.setSecret(creds[0]); // redacted in workflow logs
+    core.setSecret(creds[1]); // redacted in workflow logs
     return [
       {
         registry: 'public.ecr.aws',
@@ -87,7 +110,11 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     const ecr = new ECR({
       customUserAgent: 'docker-login-action',
       credentials,
-      region: region
+      region: region,
+      requestHandler: new NodeHttpHandler({
+        httpAgent: httpProxyAgent,
+        httpsAgent: httpsProxyAgent
+      })
     });
     const authTokenResponse = await ecr.getAuthorizationToken(authTokenRequest);
     if (!Array.isArray(authTokenResponse.authorizationData) || !authTokenResponse.authorizationData.length) {
@@ -97,6 +124,8 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     for (const authData of authTokenResponse.authorizationData) {
       const authToken = Buffer.from(authData.authorizationToken || '', 'base64').toString('utf-8');
       const creds = authToken.split(':', 2);
+      core.setSecret(creds[0]); // redacted in workflow logs
+      core.setSecret(creds[1]); // redacted in workflow logs
       regDatas.push({
         registry: authData.proxyEndpoint || '',
         username: creds[0],

src/docker.ts

@@ -1,6 +1,6 @@
 import * as aws from './aws';
 import * as core from '@actions/core';
-import * as exec from '@actions/exec';
+import {Exec} from '@docker/actions-toolkit/lib/exec';
 
 export async function login(registry: string, username: string, password: string, ecr: string): Promise<void> {
   if (/true/i.test(ecr) || (ecr == 'auto' && aws.isECR(registry))) {
@@ -11,15 +11,13 @@ export async function login(registry: string, username: string, password: string
 }
 
 export async function logout(registry: string): Promise<void> {
-  await exec
-    .getExecOutput('docker', ['logout', registry], {
-      ignoreReturnCode: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        core.warning(res.stderr.trim());
-      }
-    });
+  await Exec.getExecOutput('docker', ['logout', registry], {
+    ignoreReturnCode: true
+  }).then(res => {
+    if (res.stderr.length > 0 && res.exitCode != 0) {
+      core.warning(res.stderr.trim());
+    }
+  });
 }
 
 export async function loginStandard(registry: string, username: string, password: string): Promise<void> {
@@ -27,7 +25,7 @@ export async function loginStandard(registry: string, username: string, password
     throw new Error('Username and password required');
   }
 
-  let loginArgs: Array<string> = ['login', '--password-stdin'];
+  const loginArgs: Array<string> = ['login', '--password-stdin'];
   loginArgs.push('--username', username);
   loginArgs.push(registry);
 
@@ -36,18 +34,16 @@ export async function loginStandard(registry: string, username: string, password
   } else {
     core.info(`Logging into Docker Hub...`);
   }
-  await exec
-    .getExecOutput('docker', loginArgs, {
-      ignoreReturnCode: true,
-      silent: true,
-      input: Buffer.from(password)
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        throw new Error(res.stderr.trim());
-      }
-      core.info(`Login Succeeded!`);
-    });
+  await Exec.getExecOutput('docker', loginArgs, {
+    ignoreReturnCode: true,
+    silent: true,
+    input: Buffer.from(password)
+  }).then(res => {
+    if (res.stderr.length > 0 && res.exitCode != 0) {
+      throw new Error(res.stderr.trim());
+    }
+    core.info(`Login Succeeded!`);
+  });
 }
 
 export async function loginECR(registry: string, username: string, password: string): Promise<void> {
@@ -55,17 +51,15 @@ export async function loginECR(registry: string, username: string, password: str
   const regDatas = await aws.getRegistriesData(registry, username, password);
   for (const regData of regDatas) {
     core.info(`Logging into ${regData.registry}...`);
-    await exec
-      .getExecOutput('docker', ['login', '--password-stdin', '--username', regData.username, regData.registry], {
-        ignoreReturnCode: true,
-        silent: true,
-        input: Buffer.from(regData.password)
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          throw new Error(res.stderr.trim());
-        }
-        core.info('Login Succeeded!');
-      });
+    await Exec.getExecOutput('docker', ['login', '--password-stdin', '--username', regData.username, regData.registry], {
+      ignoreReturnCode: true,
+      silent: true,
+      input: Buffer.from(regData.password)
+    }).then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr.trim());
+      }
+      core.info('Login Succeeded!');
+    });
   }
 }

src/main.ts

@@ -1,28 +1,21 @@
-import * as core from '@actions/core';
+import * as actionsToolkit from '@docker/actions-toolkit';
+
 import * as context from './context';
 import * as docker from './docker';
 import * as stateHelper from './state-helper';
 
-export async function run(): Promise<void> {
-  try {
-    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);
-  }
+export async function main(): Promise<void> {
+  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);
 }
 
-async function logout(): Promise<void> {
+async function post(): Promise<void> {
   if (!stateHelper.logout) {
     return;
   }
   await docker.logout(stateHelper.registry);
 }
 
-if (!stateHelper.IsPost) {
-  run();
-} else {
-  logout();
-}
+actionsToolkit.run(main, post);

src/state-helper.ts

@@ -1,6 +1,5 @@
 import * as core from '@actions/core';
 
-export const IsPost = !!process.env['STATE_isPost'];
 export const registry = process.env['STATE_registry'] || '';
 export const logout = /true/i.test(process.env['STATE_logout'] || '');
 
@@ -11,7 +10,3 @@ export function setRegistry(registry: string) {
 export function setLogout(logout: boolean) {
   core.saveState('logout', logout);
 }
-
-if (!IsPost) {
-  core.saveState('isPost', 'true');
-}

tsconfig.json

@@ -1,18 +1,21 @@
 {
   "compilerOptions": {
+    "esModuleInterop": true,
     "target": "es6",
     "module": "commonjs",
-    "lib": [
-      "es6",
-      "dom"
-    ],
+    "strict": true,
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
-    "strict": true,
+    "forceConsistentCasingInFileNames": true,
     "noImplicitAny": false,
-    "esModuleInterop": true,
-    "sourceMap": true
+    "resolveJsonModule": true,
+    "useUnknownInCatchVariables": false,
   },
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "exclude": [
+    "./__tests__/**/*",
+    "./lib/**/*",
+    "node_modules",
+    "jest.config.ts"
+  ]
 }