Update readme

Compatibility with configuration sources used by other tools

.circleci/config.yml

@@ -1,70 +0,0 @@
-version: 2.1
-executors:
-  docker-executor:
-    environment:
-      IMAGE_NAME: peterevans/dockerhub-description
-    docker:
-      - image: circleci/buildpack-deps:stretch
-jobs:
-  build:
-    executor: docker-executor
-    steps:
-      - checkout
-      - setup_remote_docker:
-          docker_layer_caching: true
-      - run:
-          name: Build Docker image
-          command: |
-            docker build -t $IMAGE_NAME:latest . --label "org.opencontainers.image.version=${CIRCLE_TAG/v/''}"
-      - run:
-          name: Cache Docker image
-          command: docker save -o image.tar $IMAGE_NAME
-      - persist_to_workspace:
-          root: .
-          paths:
-            - ./image.tar
-  publish-tag:
-    executor: docker-executor
-    steps:
-      - attach_workspace:
-          at: /tmp/workspace
-      - setup_remote_docker
-      - run:
-          name: Load cached Docker image
-          command: docker load -i /tmp/workspace/image.tar
-      - run:
-          name: Publish Docker Image to Docker Hub
-          command: |
-            echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin
-            IMAGE_TAG=${CIRCLE_TAG/v/''}
-            docker tag $IMAGE_NAME:latest $IMAGE_NAME:$IMAGE_TAG
-            docker push $IMAGE_NAME:latest
-            docker push $IMAGE_NAME:$IMAGE_TAG
-            # If the minor version can be extracted then tag and push
-            MINOR_VERSION=$(echo $CIRCLE_TAG | sed -n "s/^v\([0-9]*.[0-9]*\).[0-9]*$/\1/p")
-            if [[ ${#MINOR_VERSION} -gt 0 ]]; then
-              docker tag $IMAGE_NAME:latest $IMAGE_NAME:$MINOR_VERSION
-              docker push $IMAGE_NAME:$MINOR_VERSION
-            fi
-workflows:
-  version: 2
-  build:
-    jobs:
-      - build
-  build-and-publish-tags:
-    jobs:
-      - build:
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/
-      - publish-tag:
-          context: org-global
-          requires:
-            - build
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/

.github/main.workflow

@@ -1,15 +0,0 @@
-workflow "Update Docker Hub Description" {
-  resolves = ["Docker Hub Description"]
-  on = "push"
-}
-
-action "Filter master branch" {
-  uses = "actions/bin/filter@master"
-  args = "branch master"
-}
-
-action "Docker Hub Description" {
-  needs = ["Filter master branch"]
-  uses = "./"
-  secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
-}

.github/workflows/dockerhub-description.yml

@@ -0,0 +1,24 @@
+name: Update Docker Hub Description
+on:
+  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

README.md

@@ -7,70 +7,96 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 ## Usage
 
-```
+```yml
-action "Docker Hub Description" {
+    - name: Docker Hub Description
-  uses = "peter-evans/dockerhub-description@v1.0.0"
+      uses: peter-evans/dockerhub-description@v2
-  secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
+      env:
-}
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
 ```
 
-#### Required secrets
+#### Required environment variables
 
-- `DOCKERHUB_USERNAME` - Docker Hub username
+- `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
+- `DOCKERHUB_PASSWORD` - Docker Hub password. Fallback to `DOCKER_PASSWORD` if set. Aliases: `DOCKER_PASSWORD`
-- `DOCKERHUB_REPOSITORY` - The name of the Docker Hub repository to update. The action combines this with the username to locate the repository. i.e. `username/repository`
+- `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_USERNAME` and `DOCKERHUB_REPOSITORY` may also be environment variables if not 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
 
 The action assumes that there is a file called `README.md` located at the root of the repository.
 If this is not the case, the path can be overridden with an environment variable.
 
-```
+```yml
-action "Docker Hub Description" {
+    - name: Docker Hub Description
-  uses = "peter-evans/dockerhub-description@v1.0.0"
+      uses: peter-evans/dockerhub-description@v2
-  secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
+      env:
-  env = {
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-    README_FILEPATH = "./some-path/README.md"
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-  }
+        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
-}
+        README_FILEPATH: ./some-path/README.md
 ```
 
 #### 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`.
-```
-workflow "Update Docker Hub Description" {
-  resolves = ["Docker Hub Description"]
-  on = "push"
-}
 
-action "Filter master branch" {
+```yml
-  uses = "actions/bin/filter@master"
+name: Update Docker Hub Description
-  args = "branch master"
+on:
-}
+  push:
-
+    branches:
-action "Docker Hub Description" {
+      - master
-  needs = ["Filter master branch"]
+    paths:
-  uses = "peter-evans/dockerhub-description@v1.0.0"
+      - README.md
-  secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
+      - .github/workflows/dockerhub-description.yml
-}
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v2
+      env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
 ```
 
 Updates the Docker Hub repository description whenever a new release is created.
-```
-workflow "Update Docker Hub Description" {
-  resolves = ["Docker Hub Description"]
-  on = "release"
-}
 
-action "Docker Hub Description" {
+```yml
-  uses = "peter-evans/dockerhub-description@v1.0.0"
+name: Update Docker Hub Description
-  secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
+on: release
-}
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v2
+      env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
+```
+
+## Using the Docker image independently of GitHub Actions
+
+The image can be executed in other environments independently of GitHub Actions.
+Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.
+
+```bash
+docker run -v $PWD:/workspace \
+  -e DOCKERHUB_USERNAME='user1' \
+  -e DOCKERHUB_PASSWORD='xxxxx' \
+  -e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
+  -e README_FILEPATH='/workspace/README.md' \
+  peterevans/dockerhub-description:2.2
 ```
 
 ## License
 
-MIT License - see the [LICENSE](LICENSE) file for details
+[MIT](LICENSE)

action.yml

@@ -0,0 +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.2.0'
+branding:
+  icon: 'upload'
+  color: 'blue'

entrypoint.sh

@@ -1,10 +1,36 @@
 #!/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 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}\"}"
@@ -12,8 +38,8 @@ TOKEN=$(curl -s -H "Content-Type: application/json" -X POST -d ${LOGIN_PAYLOAD}
 
 # Send a PATCH request to update the description of the repository
 echo "Sending PATCH request"
-REPO_URL="https://hub.docker.com/v2/repositories/${DOCKERHUB_USERNAME}/${DOCKERHUB_REPOSITORY}/"
+REPO_URL="https://hub.docker.com/v2/repositories/${DOCKERHUB_REPOSITORY}/"
-RESPONSE_CODE=$(curl -s --write-out %{response_code} --silent --output /dev/null -H "Authorization: JWT ${TOKEN}" -X PATCH --data-urlencode full_description@${README_FILEPATH} ${REPO_URL})
+RESPONSE_CODE=$(curl -s --write-out %{response_code} --output /dev/null -H "Authorization: JWT ${TOKEN}" -X PATCH --data-urlencode full_description@${README_FILEPATH} ${REPO_URL})
 echo "Received response code: $RESPONSE_CODE"
 
 if [ $RESPONSE_CODE -eq 200 ]; then