Refactor inputs to support docker/metadata-action (#50)

redhat-actions · Oct 12, 2021 · bdfa69a · bdfa69a
1 parent 1d3fd04
commit bdfa69a
Show file tree

Hide file tree

Showing 10 changed files with 253 additions and 221 deletions.
diff --git a/.github/workflows/multiple-build.yaml b/.github/workflows/multiple-build.yaml
@@ -10,95 +10,20 @@ env:
   IMAGE_NAMESPACE: redhat-github-actions
   IMAGE_NAME: ptr-test
   IMAGE_TAG: v1
+  SHORT_IMAGE_NAME_TAG: ptr-test:v1
+  FULLY_QUALIFIED_IMAGE_NAME_TAG: quay.io/redhat-github-actions/ptr-test:v1
 
 jobs:
-  build-only-podman:
-    name: Build and push image built only on Podman
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        install_latest: [ true, false ]
-
-    steps:
-
-      # Checkout push-to-registry action github repository
-      - name: Checkout Push to Registry action
-        uses: actions/checkout@v2
-
-      - name: Install latest podman
-        if: matrix.install_latest
-        run: |
-          bash .github/install_latest_podman.sh
-
-      - name: Build image using Podman
-        run: |
-            podman build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
-            FROM busybox
-            RUN echo "hello world"
-            EOF
-
-      - name: Push image to ${{ env.IMAGE_REGISTRY }}
-        id: push
-        uses: ./
-        with:
-          image: ${{ env.IMAGE_NAME }}
-          tags: ${{ env.IMAGE_TAG }}
-          registry: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAMESPACE }}
-          username: ${{ secrets.REGISTRY_USER }}
-          password: ${{ secrets.REGISTRY_PASSWORD }}
-
-      - name: Echo outputs
-        run: |
-          echo "${{ toJSON(steps.push.outputs) }}"
-
-  build-only-docker:
-    name: Build and push image built only on Docker
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        install_latest: [ true, false ]
-
-    steps:
-
-      # Checkout push-to-registry action github repository
-      - name: Checkout Push to Registry action
-        uses: actions/checkout@v2
-
-      - name: Install latest podman
-        if: matrix.install_latest
-        run: |
-          bash .github/install_latest_podman.sh
-
-      - name: Build image using Docker
-        run: |
-            docker build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
-            FROM busybox
-            RUN echo "hello world"
-            EOF
-
-      - name: Push image to ${{ env.IMAGE_REGISTRY }}
-        id: push
-        uses: ./
-        with:
-          image: ${{ env.IMAGE_NAME }}
-          tags: ${{ env.IMAGE_TAG }}
-          registry: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAMESPACE }}
-          username: ${{ secrets.REGISTRY_USER }}
-          password: ${{ secrets.REGISTRY_PASSWORD }}
-
-      - name: Echo outputs
-        run: |
-          echo "${{ toJSON(steps.push.outputs) }}"
-
-  build-podman-latest:
-    name: Build and push image built latest on Podman
+  build:
+    name: |-
+      Build with ${{ matrix.build_with }} and push${{ matrix.fully_qualified_image_name_tag && ' FQIN' || '' }} (latest: ${{ matrix.install_latest }})
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
         install_latest: [ true, false ]
+        build_with: [ "docker after podman", "podman after docker", "podman only", "docker only" ]
+        fully_qualified_image_name_tag: [ true, false ]
 
     steps:
 
@@ -112,62 +37,25 @@ jobs:
           bash .github/install_latest_podman.sh
 
       - name: Build image using Docker
+        if: endsWith(matrix.build_with, 'docker')
         run: |
-            docker build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
+            docker build -t ${{ matrix.fully_qualified_image_name_tag && env.FULLY_QUALIFIED_IMAGE_NAME_TAG || env.SHORT_IMAGE_NAME_TAG }} -<<EOF
             FROM busybox
             RUN echo "hello world"
             EOF
 
       - name: Build image using Podman
+        if: contains(matrix.build_with, 'podman')
         run: |
-            podman build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
-            FROM busybox
-            RUN echo "hello world"
-            EOF
-
-      - name: Push image to ${{ env.IMAGE_REGISTRY }}
-        id: push
-        uses: ./
-        with:
-          image: ${{ env.IMAGE_NAME }}
-          tags: ${{ env.IMAGE_TAG }}
-          registry: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAMESPACE }}
-          username: ${{ secrets.REGISTRY_USER }}
-          password: ${{ secrets.REGISTRY_PASSWORD }}
-
-      - name: Echo outputs
-        run: |
-          echo "${{ toJSON(steps.push.outputs) }}"
-
-  build-docker-latest:
-    name: Build and push image built latest on Docker
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        install_latest: [ true, false ]
-
-    steps:
-
-      # Checkout push-to-registry action github repository
-      - name: Checkout Push to Registry action
-        uses: actions/checkout@v2
-
-      - name: Install latest podman
-        if: matrix.install_latest
-        run: |
-          bash .github/install_latest_podman.sh
-
-      - name: Build image using Podman
-        run: |
-            podman build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
+            podman build -t ${{ matrix.fully_qualified_image_name_tag && env.FULLY_QUALIFIED_IMAGE_NAME_TAG || env.SHORT_IMAGE_NAME_TAG }} -<<EOF
             FROM busybox
             RUN echo "hello world"
             EOF
 
       - name: Build image using Docker
+        if: startsWith(matrix.build_with, 'docker')
         run: |
-            docker build -t ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} -<<EOF
+            docker build -t ${{ matrix.fully_qualified_image_name_tag && env.FULLY_QUALIFIED_IMAGE_NAME_TAG || env.SHORT_IMAGE_NAME_TAG }} -<<EOF
             FROM busybox
             RUN echo "hello world"
             EOF
@@ -177,7 +65,7 @@ jobs:
         uses: ./
         with:
           image: ${{ env.IMAGE_NAME }}
-          tags: ${{ env.IMAGE_TAG }}
+          tags: ${{ matrix.fully_qualified_image_name_tag && env.FULLY_QUALIFIED_IMAGE_NAME_TAG || env.IMAGE_TAG }}
           registry: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAMESPACE }}
           username: ${{ secrets.REGISTRY_USER }}
           password: ${{ secrets.REGISTRY_PASSWORD }}

diff --git a/README.md b/README.md
@@ -24,16 +24,16 @@ Refer to the [`podman push`](http://docs.podman.io/en/latest/markdown/podman-man
 
 | Input Name | Description | Default |
 | ---------- | ----------- | ------- |
-| image	| Name of the image you want to push. Eg. `username/imagename` or `imagename`. See the note below about naming image and registry. | **Required**
-| tags | The tag or tags of the image to push. For multiple tags, separate by a space. For example, `latest ${{ github.sha }}`. | `latest`
-| registry | Hostname and optional namespace to push the image to. Eg. `quay.io` or `quay.io/username`. See the note below about naming image and registry. | **Required**
+| image	| Name of the image you want to push. Eg. `username/imagename` or `imagename`. See the note below about naming image and registry. | **Required unless tags are provided in `<repository>:<tag>` form**
+| tags | The tag or tags of the image to push. For multiple tags, separate by whitespace. For example, `latest ${{ github.sha }}`. For multiple image names, specify tags in `<repository>:<tag>` form. For example, `quay.io/podman/stable:latest quay.io/containers/podman:latest` | `latest`
+| registry | Hostname and optional namespace to push the image to. Eg. `quay.io` or `quay.io/username`. See the note below about naming image and registry. | **Required unless tags are provided in `<repository>:<tag>` form**
 | username | Username with which to authenticate to the registry. Required unless already logged in to the registry. | None
 | password | Password, encrypted password, or access token to use to log in to the registry. Required unless already logged in to the registry. | None
 | tls-verify | Verify TLS certificates when contacting the registry. Set to `false` to skip certificate verification. | `true`
 | digestfile | After copying the image, write the digest of the resulting image to the file. The contents of this file are the digest output. | Auto-generated from image and tag
 | extra-args | Extra args to be passed to podman push. Separate arguments by newline. Do not use quotes. | None
 
-**NOTE**: You can provide the registry namespace (usually your username, or organization) either as a suffix to input `registry` (eg. `quay.io/username`) or as a prefix to input `image` (eg. `username/myimage`), but not in both. The full image path will be resolved from `<registry>/<image>`.
+**NOTE**: You can provide the registry namespace (usually your username, or organization) either as a suffix to input `registry` (eg. `quay.io/username`) or as a prefix to input `image` (eg. `username/myimage`), but not in both. The full image path will be resolved from `<registry>/<image>`. Alternatively, you can provide input `tags` as `<repository>:<tag>` with repository in fully qualified image name (FQIN) form (e.g. `quay.io/username/myimage:latest`). When FQIN tags are provided, input `image` and `registry` will be ignored.
 
 ## Action Outputs
 

diff --git a/action.yml b/action.yml
@@ -7,14 +7,14 @@ branding:
 inputs:
   image:
     description: 'Name of the image to push (e.g. username/imagename or imagename)'
-    required: true
+    required: false
   tags:
-    description: 'The tag or tags of the image to push. For multiple tags, seperate by a space. For example, "latest v1"'
+    description: 'The tag or tags of the image to push. For multiple tags, seperate by whitespace. For example, "latest v1"'
     required: false
     default: 'latest'
   registry:
     description: 'Hostname and optional namespace to push the image to (eg. quay.io/username or quay.io)'
-    required: true
+    required: false
   username:
     description: 'Username to use as credential to authenticate to the registry'
     required: false

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -14,13 +14,15 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.2.6",
-    "@actions/exec": "^1.0.4",
-    "@actions/io": "^1.0.2"
+    "@actions/exec": "^1.1.0",
+    "@actions/io": "^1.0.2",
+    "ini": "^2.0.0"
   },
   "devDependencies": {
     "@redhat-actions/action-io-generator": "^1.5.0",
     "@redhat-actions/eslint-config": "^1.3.2",
     "@redhat-actions/tsconfig": "^1.1.1",
+    "@types/ini": "^1.3.30",
     "@types/node": "^12.12.7",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",

diff --git a/src/generated/inputs-outputs.ts b/src/generated/inputs-outputs.ts
@@ -17,7 +17,7 @@ export enum Inputs {
     EXTRA_ARGS = "extra-args",
     /**
      * Name of the image to push (e.g. username/imagename or imagename)
-     * Required: true
+     * Required: false
      * Default: None.
      */
     IMAGE = "image",
@@ -29,12 +29,12 @@ export enum Inputs {
     PASSWORD = "password",
     /**
      * Hostname and optional namespace to push the image to (eg. quay.io/username or quay.io)
-     * Required: true
+     * Required: false
      * Default: None.
      */
     REGISTRY = "registry",
     /**
-     * The tag or tags of the image to push. For multiple tags, seperate by a space. For example, "latest v1"
+     * The tag or tags of the image to push. For multiple tags, seperate by whitespace. For example, "latest v1"
      * Required: false
      * Default: "latest"
      */