Update workflow

Compatibility with configuration sources used by other tools

.github/workflows/dockerhub-description.yml

@@ -0,0 +1,25 @@
+name: Update Docker Hub Description
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - README.md
+      - .github/workflows/dockerhub-description.yml
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Copy README.md to TEST.md
+        run: |
+          mkdir -p some/path
+          mv README.md some/path/TEST.md
+      - name: Docker Hub Description
+        uses: ./
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+          DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
+          README_FILEPATH: ./some/path/TEST.md

.github/workflows/push.yml

@@ -1,16 +0,0 @@
-name: Update Docker Hub Description
-on:
-  push:
-    branches:
-    - master
-jobs:
-  dockerHubDescription:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Docker Hub Description
-      uses: ./
-      env:
-        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description

README.md

@@ -1,6 +1,5 @@
 # Docker Hub Description
 [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Docker%20Hub%20Description-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/docker-hub-description)
-[![CircleCI](https://circleci.com/gh/peter-evans/dockerhub-description/tree/master.svg?style=svg)](https://circleci.com/gh/peter-evans/dockerhub-description/tree/master)
 
 A GitHub action to update a Docker Hub repository description from `README.md`.
 
@@ -10,7 +9,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 ```yml
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2.0.0
+      uses: peter-evans/dockerhub-description@v2
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -19,11 +18,11 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 #### Required environment variables
 
-- `DOCKERHUB_USERNAME` - Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository.
-- `DOCKERHUB_PASSWORD` - Docker Hub password.
-- `DOCKERHUB_REPOSITORY` - The Docker Hub repository to update in the format `<namespace>/<name>`.
+- `DOCKERHUB_USERNAME` - Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository. Aliases: `DOCKER_USERNAME`
+- `DOCKERHUB_PASSWORD` - Docker Hub password. Fallback to `DOCKER_PASSWORD` if set. Aliases: `DOCKER_PASSWORD`
+- `DOCKERHUB_REPOSITORY` - The Docker Hub repository to update in the format `<namespace>/<name>`. May also be passed as a secret if considered sensitive. Aliases: `DOCKER_REPOSITORY`, `GITHUB_REPOSITORY`
 
-Note that `DOCKERHUB_REPOSITORY` may also be passed as a secret if considered sensitive.
+**Note**: Docker Hub [Personal Access Tokens](https://docs.docker.com/docker-hub/access-tokens/) cannot be used as they are not supported by the API. See [here](https://github.com/docker/hub-feedback/issues/1927) and [here](https://github.com/docker/hub-feedback/issues/1914) for further details. Unfortunately, this means that enabling the new 2FA feature on Docker Hub will prevent the action from working.
 
 #### Optionally specifying the file path
 
@@ -32,7 +31,7 @@ If this is not the case, the path can be overridden with an environment variable
 
 ```yml
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2.0.0
+      uses: peter-evans/dockerhub-description@v2
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -42,20 +41,24 @@ If this is not the case, the path can be overridden with an environment variable
 
 #### Examples
 
-Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch.
+The following workflow updates the Docker Hub repository description whenever there are changes to `README.md` and the workflow file itself on the `master` branch. This workflow assumes its location to be `.github/workflows/dockerhub-description.yml`.
+
 ```yml
 name: Update Docker Hub Description
 on:
   push:
     branches:
-    - master
+      - master
+    paths:
+      - README.md
+      - .github/workflows/dockerhub-description.yml
 jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2.0.0
+      uses: peter-evans/dockerhub-description@v2
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -63,6 +66,7 @@ jobs:
 ```
 
 Updates the Docker Hub repository description whenever a new release is created.
+
 ```yml
 name: Update Docker Hub Description
 on: release
@@ -70,9 +74,9 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2.0.0
+      uses: peter-evans/dockerhub-description@v2
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -90,9 +94,9 @@ docker run -v $PWD:/workspace \
   -e DOCKERHUB_PASSWORD='xxxxx' \
   -e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
   -e README_FILEPATH='/workspace/README.md' \
-  peterevans/dockerhub-description:2.0.0
+  peterevans/dockerhub-description:2.3
 ```
 
 ## License
 
-MIT License - see the [LICENSE](LICENSE) file for details
+[MIT](LICENSE)

action.yml

@@ -1,9 +1,22 @@
 name: 'Docker Hub Description'
 author: 'Peter Evans'
 description: 'An action to update a Docker Hub repository description from README.md'
+# env:
+#   DOCKERHUB_USERNAME:
+#     description: Username to login to Docker Hub. Aliases: DOCKER_USERNAME
+#     required: true
+#   DOCKERHUB_PASSWORD:
+#     description: Password to login to Docker Hub. Aliases: DOCKER_PASSWORD
+#     required: true
+#   DOCKERHUB_REPOSITORY:
+#     description: Explicit Docker Hub repository name. Aliases: DOCKER_REPOSITORY, GITHUB_REPOSITORY
+#     required: true
+#   README_FILEPATH:
+#     description: Path to the repository readme.
+#     default: ./README.md
 runs:
   using: 'docker'
-  image: 'docker://peterevans/dockerhub-description:2.1.0'
+  image: 'docker://peterevans/dockerhub-description:2.3.1'
 branding:
-  icon: 'upload'  
+  icon: 'upload'
   color: 'blue'

entrypoint.sh

@@ -1,10 +1,42 @@
 #!/bin/sh -l
-set -euo pipefail
+set -eo pipefail
 IFS=$'\n\t'
 
+# Allow DOCKERHUB_* variables to be set from their DOCKER_* variant
+DOCKERHUB_USERNAME=${DOCKERHUB_USERNAME:-${DOCKER_USERNAME}}
+DOCKERHUB_PASSWORD=${DOCKERHUB_PASSWORD:-${DOCKER_PASSWORD}}
+DOCKERHUB_REPOSITORY=${DOCKERHUB_REPOSITORY:-${DOCKER_REPOSITORY}}
+
+# If the repository isn't explicitly defined, infer it from GitHub if possible
+DOCKERHUB_REPOSITORY=${DOCKERHUB_REPOSITORY:-${GITHUB_REPOSITORY}}
+
+# Validate we can authenticate
+if [ -z "$DOCKERHUB_USERNAME" ] || [ -z "$DOCKERHUB_PASSWORD" ]; then
+  echo 'Unable to authenticate with Docker Hub, set a valid $DOCKERHUB_USERNAME and $DOCKERHUB_PASSWORD'
+  exit 1
+fi
+
+# Validate we have the repository name
+if [ -z "$DOCKERHUB_REPOSITORY" ]; then
+  echo 'Unable to determine Docker Hub repository name, set with $DOCKERHUB_REPOSITORY'
+  exit 1
+fi
+
 # Set the default path to README.md
 README_FILEPATH=${README_FILEPATH:="./README.md"}
 
+# Check the file exists
+if [ ! -f ${README_FILEPATH} ]; then
+  echo "Readme file not found"
+  exit 1
+fi
+
+# Check the file size
+if [ $(wc -c <${README_FILEPATH}) -gt 25000 ]; then
+  echo "File size exceeds the maximum allowed 25000 bytes"
+  exit 1
+fi
+
 # Acquire a token for the Docker Hub API
 echo "Acquiring token"
 LOGIN_PAYLOAD="{\"username\": \"${DOCKERHUB_USERNAME}\", \"password\": \"${DOCKERHUB_PASSWORD}\"}"
@@ -17,7 +49,9 @@ RESPONSE_CODE=$(curl -s --write-out %{response_code} --output /dev/null -H "Auth
 echo "Received response code: $RESPONSE_CODE"
 
 if [ $RESPONSE_CODE -eq 200 ]; then
+  echo "Request successful"
   exit 0
 else
+  echo "Request failed"
   exit 1
 fi