Merge branch 'master' of https://github.com/machine-learning-apps/gpr-docker-publish

# Conflicts:
#	README.md
#	action.yml
#	entrypoint.sh

Author: Patrick Poetz

.github/workflows/main.yml

@@ -14,18 +14,16 @@ jobs:
       - name: Build and Publish Docker image in GPR
         uses: saubermacherag/gpr-docker-publish@master
         with:
-          USERNAME: x-access-token
-          PASSWORD: ${{ secrets.GITHUB_TOKEN }}
           IMAGE_NAME: 'gpr-docker-publish-test'
-          IMAGE_TAG: 'v0.0'
+          TAG: 'v0.0'
           DOCKERFILE_PATH: '.github/docker/Dockerfile'
-          BUILD_CONTEXT: './'
+          BUILD_CONTEXT: '.'
       - name: Build and Publish Docker image to Dockerhub instead of GPR
         uses: saubermacherag/gpr-docker-publish@master
         with:
-          USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-          PASSWORD: ${{ secrets.DOCKERHUB_PAT }}
-          IMAGE_TAG: 'v0.0'
+          TAG: 'v0.0'
           DOCKERFILE_PATH: '.github/docker/Dockerfile'
-          BUILD_CONTEXT: './'
-          DOCKERHUB_REPOSITORY: 'pinkrobin/gpr-docker-publish-example'
+          BUILD_CONTEXT: '.'
+          DOCKERHUB_REPOSITORY: 'pinkrobin/gpr-docker-publish-example'
+        env:
+          GITHUB_TOKEN: ${{ secrets.DOCKERHUB_PAT }}

.github/workflows/test.yaml

@@ -0,0 +1,20 @@
+name: Tests
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest 
+    steps:
+
+    - name: Copy Repo Files
+      uses: actions/checkout@master
+
+    - name: Publish Docker Image to GPR
+      uses: machine-learning-apps/gpr-docker-publish@master
+      with:
+        IMAGE_NAME: 'test-docker-action-v2'
+        TAG: 'my-optional-tag-name'
+        DOCKERFILE_PATH: 'Dockerfile'
+        BUILD_CONTEXT: '.'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -7,9 +7,9 @@ LABEL "com.github.actions.color"="purple"
 
 RUN apk update \
   && apk upgrade \
-  && apk add --no-cache git
+  && apk add --no-cache git curl jq
 
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,3 +1,6 @@
+![Actions Status](https://github.com/machine-learning-apps/gpr-docker-publish/workflows/Tests/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/machine-learning-apps/gpr-docker-publish/blob/master/LICENSE)
+
+
 ## This Action Publishes Docker Images to the [GitHub Package Registry](https://github.com/features/package-registry).  
 
 ### Background On The GitHub Package Registry (GPR):
@@ -52,12 +55,12 @@ jobs:
       uses: machine-learning-apps/gpr-docker-publish@master
       id: docker
       with:
-        USERNAME: ${{ secrets.DOCKER_USERNAME }}
-        PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
         IMAGE_NAME: 'test-docker-action'
-        IMAGE_TAG: 'v0.0'
+        TAG: 'my-optional-tag-name'
         DOCKERFILE_PATH: 'argo/gpu.Dockerfile'
         BUILD_CONTEXT: 'argo/'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     #To access another docker registry like dockerhub you'll have to add `DOCKERHUB_UERNAME` and `DOCKERHUB_PAT` in github secrets.
     - name: Build and Publish Docker image to Dockerhub instead of GPR
@@ -83,16 +86,14 @@ jobs:
 
 ### Mandatory Inputs
 
-1. `USERNAME` the login username, most likely your github handle.  This username must have write access to the repo where the action is called. `x-access-token` should suffice.
-2. `PASSWORD` Your GitHub password that has write access to the repo where this action is called. `${{ secrets.GITHUB_TOKEN }}` should suffice.
-3. `IMAGE_NAME` is the name of the image you would like to push  
-4. `DOCKERFILE_PATH`: The full path (including the filename) relative to the root of the repository that contains the Dockerfile that specifies your build.
-5. `BUILD_CONTEXT`: The directory for the build context.  See these [docs](https://docs.docker.com/engine/reference/commandline/build/) for more information on the definition of build context.
+1. `IMAGE_NAME` is the name of the image you would like to push  
+2. `DOCKERFILE_PATH`: The full path (including the filename) relative to the root of the repository that contains the Dockerfile that specifies your build.
+3. `BUILD_CONTEXT`: The directory for the build context.  See these [docs](https://docs.docker.com/engine/reference/commandline/build/) for more information on the definition of build context.
 
 ## Optional Inputs
 
 1. `cache`: if value is `true`, attempts to use the last pushed image as a cache.  Default value is `false`.
-2. `IMAGE_TAG`: if value is set, use provided value.  Default value is the first 12 characters of the GitHub SHA that triggered the action.
+2. `tag`: a custom tag you wish to assign to the image.
 3. `DOCKERHUB_REPOSITORY`: if value is set, you don't need to set `IMAGE_NAME`. It will push the image to the given dockerhub repository instead of using GPR.
 Why? Because Github Actions don't support downloading images without authentication at the moment. See: https://github.community/t5/GitHub-Actions/docker-pull-from-public-GitHub-Package-Registry-fail-with-quot/m-p/32782
 

action.yaml renamed to action.yml

@@ -2,12 +2,6 @@ name: 'gpr-docker-publish'
 description: Publish a Docker image to GitHub Package Registry
 author: Hamel Husain
 inputs:
-  password:
-    description: Your GitHub password corresponding to write access to the repo where this action is called.
-    required: true
-  username:
-    description: Your GitHub password corresponding to write access to the repo where this action is called.
-    require: true
   image_name:
     description: name of the image.  Example - myContainer
     required: true
@@ -23,8 +17,8 @@ inputs:
     description: attempt to use last image as the cache
     required: false
     default: false
-  image_tag:
-    description: Optional input to set a tag name instead of a hash.
+  tag:
+    description: custom tag you want to assign to the image.
     required: false
   dockerhub_repository:
     description: Optional input to push image to dockerhub repository instead of GPR.
@@ -39,4 +33,4 @@ branding:
   icon: 'layers'
 runs:
   using: 'docker'
-  image: 'Dockerfile'
+  image: 'Dockerfile'

entrypoint.sh

@@ -7,13 +7,8 @@
 set -e
 
 #check inputs
-if [[ -z "$INPUT_USERNAME" ]]; then
-	echo "Set the USERNAME input."
-	exit 1
-fi
-
-if [[ -z "$INPUT_PASSWORD" ]]; then
-	echo "Set the PASSWORD input."
+if [[ -z "$GITHUB_TOKEN" ]]; then
+	echo "You must supply the environment variable GITHUB_TOKEN."
 	exit 1
 fi
 
@@ -32,11 +27,6 @@ if [[ -z "$INPUT_BUILD_CONTEXT" ]]; then
 	exit 1
 fi
 
-if [[ -z "$INPUT_IMAGE_TAG" ]]; then
-	IMAGE_TAG=$(echo "${GITHUB_SHA}" | cut -c1-12)
-else
-	IMAGE_TAG=$INPUT_IMAGE_TAG
-fi
 
 # The following environment variables will be provided by the environment automatically: GITHUB_REPOSITORY, GITHUB_SHA
 
@@ -48,10 +38,14 @@ else
 fi
 
 # send credentials through stdin (it is more secure)
-echo ${INPUT_PASSWORD} | docker login -u ${INPUT_USERNAME} --password-stdin ${DOCKER_REGISTRY}
+user=$(curl -s -H "Authorization: token ${GITHUB_TOKEN}" https://api.github.com/user | jq -r .login)
+# lowercase the username
+username="$(echo ${user} | tr "[:upper:]" "[:lower:]")"
+echo ${GITHUB_TOKEN} | docker login -u "${username}" --password-stdin ${DOCKER_REGISTRY}
 
 # Set Local Variables
-SHA_NAME="${BASE_NAME}:${IMAGE_TAG}"
+shortSHA=$(echo "${GITHUB_SHA}" | cut -c1-12)
+SHA_NAME="${BASE_NAME}:${shortSHA}"
 
 # Build additional tags based on the GIT Tags pointing to the current commit
 ADDITIONAL_TAGS=
@@ -73,7 +67,14 @@ if [ "${INPUT_CACHE}" == "true" ]; then
 fi
 
 # Build The Container
-docker build $BUILDPARAMS -t ${SHA_NAME} -t ${BASE_NAME}${ADDITIONAL_TAGS} -f ${INPUT_DOCKERFILE_PATH} ${INPUT_BUILD_CONTEXT}
+if [ "${INPUT_TAG}" ]; then
+   CUSTOM_TAG="${BASE_NAME}:${INPUT_TAG}"
+   docker build $BUILDPARAMS -t ${SHA_NAME} -t ${BASE_NAME}${ADDITIONAL_TAGS} -t ${CUSTOM_TAG} -f ${INPUT_DOCKERFILE_PATH} ${INPUT_BUILD_CONTEXT}
+   docker push ${CUSTOM_TAG}
+else
+   docker build $BUILDPARAMS -t ${SHA_NAME} -t ${BASE_NAME}${ADDITIONAL_TAGS} -f ${INPUT_DOCKERFILE_PATH} ${INPUT_BUILD_CONTEXT}
+fi
+
 
 # Push two versions, with and without the SHA
 docker push ${BASE_NAME}