Merge pull request #41 from crazy-max/fix-public-ecr

Fix public ECR login with AWS CLI v1

.github/workflows/ci.yml

@@ -1,93 +1,61 @@
 name: ci
 
 on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 10 * * *' # everyday at 10am
   push:
     branches:
       - master
-      - releases/v*
 
 jobs:
-#  dockerhub:
+  dind:
-#    runs-on: ${{ matrix.os }}
-#    strategy:
-#      fail-fast: false
-#      matrix:
-#        os:
-#          - ubuntu-20.04
-#          - ubuntu-18.04
-#          - ubuntu-16.04
-#        logout:
-#          - true
-#          - false
-#    steps:
-#      -
-#        name: Checkout
-#        uses: actions/checkout@v2.3.2
-#      -
-#        name: Login to DockerHub
-#        uses: ./
-#        with:
-#          username: ${{ secrets.DOCKERHUB_USERNAME_TEST }}
-#          password: ${{ secrets.DOCKERHUB_PASSWORD_TEST }}
-#          logout: ${{ matrix.logout }}
-#      -
-#        name: Clear
-#        if: always()
-#        run: |
-#          rm -f ${HOME}/.docker/config.json
-
-  gpr:
     runs-on: ubuntu-latest
-    strategy:
+    env:
-      fail-fast: false
+      DOCKER_CONFIG: $HOME/.docker
-      matrix:
-        logout:
-          - true
-          - false
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.2
+        uses: actions/checkout@v2
       -
-        name: Login to GitHub Package Registry
+        name: Login to GitHub Container Registry
         uses: ./
         with:
-          registry: docker.pkg.github.com
+          registry: ghcr.io
-          username: ${{ github.repository_owner }}
+          username: ${{ secrets.GHCR_USERNAME }}
-          password: ${{ secrets.GITHUB_TOKEN }}
+          password: ${{ secrets.GHCR_PAT }}
-          logout: ${{ matrix.logout }}
       -
-        name: Clear
+        name: DinD
-        if: always()
+        uses: docker://docker
+        with:
+          entrypoint: docker
+          args: pull ghcr.io/docker-ghactiontest/test
+      -
+        name: Pull private image
         run: |
-          rm -f ${HOME}/.docker/config.json
+          docker image prune -a -f >/dev/null 2>&1
+          docker pull ghcr.io/docker-ghactiontest/test
+
+  dockerhub:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-20.04
+          - ubuntu-18.04
+          - ubuntu-16.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Login to Docker Hub
+        uses: ./
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-#  gitlab:
-#    runs-on: ubuntu-latest
-#    strategy:
-#      fail-fast: false
-#      matrix:
-#        logout:
-#          - true
-#          - false
-#    steps:
-#      -
-#        name: Checkout
-#        uses: actions/checkout@v2.3.2
-#      -
-#        name: Login to GitLab
-#        uses: ./
-#        with:
-#          registry: registry.gitlab.com
-#          username: ${{ secrets.GITLAB_USERNAME_TEST }}
-#          password: ${{ secrets.GITLAB_PASSWORD_TEST }}
-#          logout: ${{ matrix.logout }}
-#      -
-#        name: Clear
-#        if: always()
-#        run: |
-#          rm -f ${HOME}/.docker/config.json
-#
 #  ecr:
 #    runs-on: ${{ matrix.os }}
 #    strategy:
@@ -97,13 +65,10 @@ jobs:
 #          - ubuntu-20.04
 #          - ubuntu-18.04
 #          - ubuntu-16.04
-#        logout:
-#          - true
-#          - false
 #    steps:
 #      -
 #        name: Checkout
-#        uses: actions/checkout@v2.3.1
+#        uses: actions/checkout@v2
 #      -
 #        name: Login to ECR
 #        uses: ./
@@ -111,12 +76,6 @@ jobs:
 #          registry: ${{ secrets.AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.AWS_REGION }}.amazonaws.com
 #          username: ${{ secrets.AWS_ACCESS_KEY_ID }}
 #          password: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-#          logout: ${{ matrix.logout }}
-#      -
-#        name: Clear
-#        if: always()
-#        run: |
-#          rm -f ${HOME}/.docker/config.json
 #
 #  ecr-aws-creds:
 #    runs-on: ${{ matrix.os }}
@@ -130,7 +89,7 @@ jobs:
 #    steps:
 #      -
 #        name: Checkout
-#        uses: actions/checkout@v2.3.1
+#        uses: actions/checkout@v2
 #      -
 #        name: Configure AWS Credentials
 #        uses: aws-actions/configure-aws-credentials@v1
@@ -143,8 +102,73 @@ jobs:
 #        uses: ./
 #        with:
 #          registry: ${{ secrets.AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.AWS_REGION }}.amazonaws.com
+
+  github-package:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Login to GitHub Package Registry
+        uses: ./
+        with:
+          registry: docker.pkg.github.com
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+  github-container:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Login to GitHub Container Registry
+        uses: ./
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.GHCR_USERNAME }}
+          password: ${{ secrets.GHCR_PAT }}
+
+  gitlab:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Login to GitLab
+        uses: ./
+        with:
+          registry: registry.gitlab.com
+          username: ${{ secrets.GITLAB_USERNAME }}
+          password: ${{ secrets.GITLAB_TOKEN }}
+
+#  google-artifact:
+#    runs-on: ubuntu-latest
+#    steps:
 #      -
-#        name: Clear
+#        name: Checkout
-#        if: always()
+#        uses: actions/checkout@v2
-#        run: |
+#      -
-#          rm -f ${HOME}/.docker/config.json
+#        name: Login to Google Artifact Registry
+#        uses: ./
+#        with:
+#          registry: ${{ secrets.GAR_LOCATION }}-docker.pkg.dev
+#          username: _json_key
+#          password: ${{ secrets.GAR_JSON_KEY }}
+#
+#  google-container:
+#    runs-on: ubuntu-latest
+#    steps:
+#      -
+#        name: Checkout
+#        uses: actions/checkout@v2
+#      -
+#        name: Login to Google Container Registry
+#        uses: ./
+#        with:
+#          registry: gcr.io
+#          username: _json_key
+#          password: ${{ secrets.GCR_JSON_KEY }}

.github/workflows/labels.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.2
+        uses: actions/checkout@v2
       -
         name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.0.0
+        uses: crazy-max/ghaction-github-labeler@v3

.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.2
+        uses: actions/checkout@v2
       -
         name: Install
         run: yarn install
@@ -33,7 +33,7 @@ jobs:
         run: yarn run test
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v1.0.13
+        uses: codecov/codecov-action@v1
         if: success()
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -18,13 +18,16 @@ GitHub Action to login against a Docker registry.
 ___
 
 * [Usage](#usage)
-  * [DockerHub](#dockerhub)
+  * [Docker Hub](#docker-hub)
   * [GitHub Packages Docker Registry](#github-packages-docker-registry)
   * [GitHub Container Registry](#github-container-registry)
   * [GitLab](#gitlab)
   * [Azure Container Registry (ACR)](#azure-container-registry-acr)
   * [Google Container Registry (GCR)](#google-container-registry-gcr)
+  * [Google Artifact Registry (GAR)](#google-artifact-registry-gar)
   * [AWS Elastic Container Registry (ECR)](#aws-elastic-container-registry-ecr)
+  * [AWS Public Elastic Container Registry (ECR)](#aws-public-elastic-container-registry-ecr)
+  * [OCI Oracle Cloud Infrastructure Registry (OCIR)](#oci-oracle-cloud-infrastructure-registry-ocir)
 * [Customizing](#customizing)
   * [inputs](#inputs)
 * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
@@ -32,9 +35,9 @@ ___
 
 ## Usage
 
-### DockerHub
+### Docker Hub
 
-To authenticate against [DockerHub](https://hub.docker.com) it's strongly recommended to create a
+To authenticate against [Docker Hub](https://hub.docker.com) it's strongly recommended to create a
 [personal access token](https://docs.docker.com/docker-hub/access-tokens/) as an alternative to your password.
 
 ```yaml
@@ -49,7 +52,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -162,6 +165,11 @@ jobs:
 
 ### Google Container Registry (GCR)
 
+> [Google Artifact Registry](#google-artifact-registry-gar) is the evolution of Google Container Registry. As a
+> fully-managed service with support for both container images and non-container artifacts. If you currently use
+> 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. 
+
 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)
@@ -187,6 +195,36 @@ jobs:
           password: ${{ secrets.GCR_JSON_KEY }}
 ```
 
+### Google Artifact Registry (GAR)
+
+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)
+called `GAR_JSON_KEY` in your GitHub repo. Ensure you set the username to `_json_key`.
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: master
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Login to GAR
+        uses: docker/login-action@v1
+        with:
+          registry: <location>-docker.pkg.dev
+          username: _json_key
+          password: ${{ secrets.GAR_JSON_KEY }}
+```
+
+> 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.
+
 ### AWS Elastic Container Registry (ECR)
 
 Use an IAM user with the [ability to push to ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/ecr_managed_policies.html).
@@ -243,6 +281,93 @@ jobs:
 
 > Replace `<aws-account-number>` and `<region>` with their respective values.
 
+### AWS Public Elastic Container Registry (ECR)
+
+Use an IAM user with the [ability to push to ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/ecr_managed_policies.html).
+Then create and download access keys and save `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` [as secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository)
+in your GitHub repo.
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: master
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Login to Public ECR
+        uses: docker/login-action@v1
+        with:
+          registry: public.ecr.aws
+          username: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          password: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        env:
+          AWS_REGION: <region>
+```
+
+> Replace `<region>` with its respective value (default `us-east-1`).
+
+You can also use the [Configure AWS Credentials](https://github.com/aws-actions/configure-aws-credentials) action in
+combination with this action:
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: master
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: <region>
+      -
+        name: Login to Public ECR
+        uses: docker/login-action@v1
+        with:
+          registry: public.ecr.aws
+```
+
+> Replace `<region>` with its respective value.
+
+### OCI Oracle Cloud Infrastructure Registry (OCIR)
+To push into OCIR in specific tenancy the [username](https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/registry/index.html#LogintoOracleCloudInfrastructureRegistryfromtheDockerCLI)
+must be placed in format `<tenancy>/<username>` (in case of federated tenancy use the format `<tenancy-namespace>/oracleidentitycloudservice/<username>`). 
+For password [create an auth token](https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/registry/index.html#GetanAuthToken). Save username and token
+ [as a secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) in your GitHub repo. 
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: master
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Login to OCIR
+        uses: docker/login-action@v1
+        with:
+          registry: <region>.ocir.io
+          username: ${{ secrets.OCI_USERNAME }}
+          password: ${{ secrets.OCI_TOKEN }}
+```
+> Replace `<region>` with their respective values from [availability regions](https://docs.cloud.oracle.com/iaas/Content/Registry/Concepts/registryprerequisites.htm#Availab)
+
 ## Customizing
 
 ### inputs

__tests__/aws.test.ts

@@ -5,12 +5,24 @@ describe('isECR', () => {
   test.each([
     ['registry.gitlab.com', false],
     ['gcr.io', false],
-    ['012345678901.dkr.ecr.eu-west-3.amazonaws.com', true]
+    ['012345678901.dkr.ecr.eu-west-3.amazonaws.com', true],
+    ['public.ecr.aws', true]
   ])('given registry %p', async (registry, expected) => {
     expect(await aws.isECR(registry)).toEqual(expected);
   });
 });
 
+describe('isPubECR', () => {
+  test.each([
+    ['registry.gitlab.com', false],
+    ['gcr.io', false],
+    ['012345678901.dkr.ecr.eu-west-3.amazonaws.com', false],
+    ['public.ecr.aws', true]
+  ])('given registry %p', async (registry, expected) => {
+    expect(await aws.isPubECR(registry)).toEqual(expected);
+  });
+});
+
 describe('getCLI', () => {
   it('exists', async () => {
     const awsPath = await aws.getCLI();
@@ -45,10 +57,10 @@ describe('parseCLIVersion', () => {
 });
 
 describe('getRegion', () => {
-  test.each([['012345678901.dkr.ecr.eu-west-3.amazonaws.com', 'eu-west-3']])(
+  test.each([
-    'given registry %p',
+    ['012345678901.dkr.ecr.eu-west-3.amazonaws.com', 'eu-west-3'],
-    async (registry, expected) => {
+    ['public.ecr.aws', 'us-east-1']
-      expect(await aws.getRegion(registry)).toEqual(expected);
+  ])('given registry %p', async (registry, expected) => {
-    }
+    expect(await aws.getRegion(registry)).toEqual(expected);
-  );
+  });
 });

dist/index.js

@@ -3072,7 +3072,7 @@ function loginStandard(registry, username, password) {
             core.info(`🔑 Logging into ${registry}...`);
         }
         else {
-            core.info(`🔑 Logging into DockerHub...`);
+            core.info(`🔑 Logging into Docker Hub...`);
         }
         yield execm.exec('docker', loginArgs, true, password).then(res => {
             if (res.stderr != '' && !res.success) {
@@ -3088,7 +3088,12 @@ function loginECR(registry, username, password) {
         const cliPath = yield aws.getCLI();
         const cliVersion = yield aws.getCLIVersion();
         const region = yield aws.getRegion(registry);
-        core.info(`💡 AWS ECR detected with ${region} region`);
+        if (yield aws.isPubECR(registry)) {
+            core.info(`💡 AWS Public ECR detected with ${region} region`);
+        }
+        else {
+            core.info(`💡 AWS ECR detected with ${region} region`);
+        }
         process.env.AWS_ACCESS_KEY_ID = username || process.env.AWS_ACCESS_KEY_ID;
         process.env.AWS_SECRET_ACCESS_KEY = password || process.env.AWS_SECRET_ACCESS_KEY;
         core.info(`⬇️ Retrieving docker login command through AWS CLI ${cliVersion} (${cliPath})...`);
@@ -4155,14 +4160,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDockerLoginCmd = exports.parseCLIVersion = exports.getCLIVersion = exports.execCLI = exports.getCLI = exports.getRegion = exports.isECR = void 0;
+exports.getDockerLoginCmd = exports.parseCLIVersion = exports.getCLIVersion = exports.execCLI = exports.getCLI = exports.getRegion = exports.isPubECR = exports.isECR = void 0;
 const semver = __importStar(__webpack_require__(383));
 const io = __importStar(__webpack_require__(436));
 const execm = __importStar(__webpack_require__(757));
 exports.isECR = (registry) => __awaiter(void 0, void 0, void 0, function* () {
-    return registry.includes('amazonaws');
+    return registry.includes('amazonaws') || (yield exports.isPubECR(registry));
+});
+exports.isPubECR = (registry) => __awaiter(void 0, void 0, void 0, function* () {
+    return registry === 'public.ecr.aws';
 });
 exports.getRegion = (registry) => __awaiter(void 0, void 0, void 0, function* () {
+    if (yield exports.isPubECR(registry)) {
+        return process.env.AWS_REGION || process.env.AWS_DEFAULT_REGION || 'us-east-1';
+    }
     return registry.substring(registry.indexOf('ecr.') + 4, registry.indexOf('.amazonaws'));
 });
 exports.getCLI = () => __awaiter(void 0, void 0, void 0, function* () {
@@ -4192,13 +4203,14 @@ exports.parseCLIVersion = (stdout) => __awaiter(void 0, void 0, void 0, function
     return semver.clean(matches[1]);
 });
 exports.getDockerLoginCmd = (cliVersion, registry, region) => __awaiter(void 0, void 0, void 0, function* () {
-    if (semver.satisfies(cliVersion, '>=2.0.0')) {
+    let ecrCmd = (yield exports.isPubECR(registry)) ? 'ecr-public' : 'ecr';
-        return exports.execCLI(['ecr', 'get-login-password', '--region', region]).then(pwd => {
+    if (semver.satisfies(cliVersion, '>=2.0.0') || (yield exports.isPubECR(registry))) {
+        return exports.execCLI([ecrCmd, 'get-login-password', '--region', region]).then(pwd => {
             return `docker login --username AWS --password ${pwd} ${registry}`;
         });
     }
     else {
-        return exports.execCLI(['ecr', 'get-login', '--region', region, '--no-include-email']).then(dockerLoginCmd => {
+        return exports.execCLI([ecrCmd, 'get-login', '--region', region, '--no-include-email']).then(dockerLoginCmd => {
             return dockerLoginCmd;
         });
     }

src/aws.ts

@@ -3,10 +3,17 @@ import * as io from '@actions/io';
 import * as execm from './exec';
 
 export const isECR = async (registry: string): Promise<boolean> => {
-  return registry.includes('amazonaws');
+  return registry.includes('amazonaws') || (await isPubECR(registry));
+};
+
+export const isPubECR = async (registry: string): Promise<boolean> => {
+  return registry === 'public.ecr.aws';
 };
 
 export const getRegion = async (registry: string): Promise<string> => {
+  if (await isPubECR(registry)) {
+    return process.env.AWS_REGION || process.env.AWS_DEFAULT_REGION || 'us-east-1';
+  }
   return registry.substring(registry.indexOf('ecr.') + 4, registry.indexOf('.amazonaws'));
 };
 
@@ -39,12 +46,13 @@ export const parseCLIVersion = async (stdout: string): Promise<string> => {
 };
 
 export const getDockerLoginCmd = async (cliVersion: string, registry: string, region: string): Promise<string> => {
-  if (semver.satisfies(cliVersion, '>=2.0.0')) {
+  let ecrCmd = (await isPubECR(registry)) ? 'ecr-public' : 'ecr';
-    return execCLI(['ecr', 'get-login-password', '--region', region]).then(pwd => {
+  if (semver.satisfies(cliVersion, '>=2.0.0') || (await isPubECR(registry))) {
+    return execCLI([ecrCmd, 'get-login-password', '--region', region]).then(pwd => {
       return `docker login --username AWS --password ${pwd} ${registry}`;
     });
   } else {
-    return execCLI(['ecr', 'get-login', '--region', region, '--no-include-email']).then(dockerLoginCmd => {
+    return execCLI([ecrCmd, 'get-login', '--region', region, '--no-include-email']).then(dockerLoginCmd => {
       return dockerLoginCmd;
     });
   }

src/docker.ts

@@ -30,7 +30,7 @@ export async function loginStandard(registry: string, username: string, password
   if (registry) {
     core.info(`🔑 Logging into ${registry}...`);
   } else {
-    core.info(`🔑 Logging into DockerHub...`);
+    core.info(`🔑 Logging into Docker Hub...`);
   }
   await execm.exec('docker', loginArgs, true, password).then(res => {
     if (res.stderr != '' && !res.success) {
@@ -44,7 +44,12 @@ export async function loginECR(registry: string, username: string, password: str
   const cliPath = await aws.getCLI();
   const cliVersion = await aws.getCLIVersion();
   const region = await aws.getRegion(registry);
-  core.info(`💡 AWS ECR detected with ${region} region`);
+
+  if (await aws.isPubECR(registry)) {
+    core.info(`💡 AWS Public ECR detected with ${region} region`);
+  } else {
+    core.info(`💡 AWS ECR detected with ${region} region`);
+  }
 
   process.env.AWS_ACCESS_KEY_ID = username || process.env.AWS_ACCESS_KEY_ID;
   process.env.AWS_SECRET_ACCESS_KEY = password || process.env.AWS_SECRET_ACCESS_KEY;