Merge pull request #50 from peter-evans/update-distribution

Update distribution

.eslintignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "env": { "node": true, "jest": true },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/camelcase": "off"
+  }
+}

.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - run: npm ci
+      - run: npm run build
+      - run: npm run format-check
+      - run: npm run lint
+      - run: npm run test
+      - uses: actions/upload-artifact@v2
+        with:
+          name: dist
+          path: dist
+      - uses: actions/upload-artifact@v2
+        with:
+          name: action.yml
+          path: action.yml
+
+  test:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [built, committed]
+    steps:
+      - uses: actions/checkout@v2
+      - if: matrix.target == 'built' || github.event_name == 'pull_request'
+        uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+      - if: matrix.target == 'built' || github.event_name == 'pull_request'
+        uses: actions/download-artifact@v2
+        with:
+          name: action.yml
+          path: .
+
+      # Tests
+
+      - name: Prepare non-default filepath
+        run: |
+          mkdir -p some/path
+          cp README.md some/path/TEST.md
+
+      - name: Docker Hub Description (with)
+        uses: ./
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: peterevans/dd-ci-fixture-${{ matrix.target }}
+          short-description: ${{ matrix.target }} test fixture for dockerhub-description action
+          readme-filepath: ./some/path/TEST.md
+
+      - name: Docker Hub Description (env)
+        uses: ./
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+          DOCKERHUB_REPOSITORY: peterevans/dd-ci-fixture-${{ matrix.target }}
+
+  package:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: 'build: update distribution'
+          title: Update distribution
+          body: |
+            - Updates the distribution for changes on `main`
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: update-distribution

.github/workflows/dockerhub-description.yml

@@ -1,8 +1,9 @@
 name: Update Docker Hub Description
 on:
+  workflow_dispatch:
   push:
     branches:
-      - master
+      - main
     paths:
       - README.md
       - .github/workflows/dockerhub-description.yml
@@ -11,14 +12,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Copy README.md to TEST.md
+
+      - name: Modify readme for DockerHub
         run: |
-          mkdir -p some/path
-          mv README.md some/path/TEST.md
+          sed -i 's/# Docker Hub Description/# [Docker Hub Description](https:\/\/github.com\/peter-evans\/dockerhub-description)/' README.md
+          sed -i 's/(LICENSE)/(https:\/\/github.com\/peter-evans\/dockerhub-description\/blob\/main\/LICENSE)/' README.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
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: peterevans/dockerhub-description
+          short-description: ${{ github.event.repository.description }}

.github/workflows/publish-docker.yml

@@ -0,0 +1,41 @@
+name: Publish Docker Image
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+env:
+  IMAGE_NAME: peterevans/dockerhub-description
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Docker Hub login
+        run: echo "${{ secrets.DOCKERHUB_PASSWORD }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin
+
+      - name: Push image to Docker Hub
+        run: |
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "main" ] && VERSION=latest
+
+          # Build and tag image
+          docker build . --file Dockerfile --tag $IMAGE_NAME --label "org.opencontainers.image.version=$VERSION"
+          docker tag $IMAGE_NAME $IMAGE_NAME:$VERSION
+
+          # Tag with the minor version if valid
+          MINOR_VERSION=$(echo $VERSION | sed -n "s/^\([0-9]*.[0-9]*\).[0-9]*$/\1/p")
+          [[ ${#MINOR_VERSION} -gt 0 ]] && docker tag $IMAGE_NAME $IMAGE_NAME:$MINOR_VERSION
+          # Tag with the major version if valid
+          MAJOR_VERSION=$(echo $VERSION | sed -n "s/^\([0-9]*\).[0-9]*.[0-9]*$/\1/p")
+          [[ ${#MAJOR_VERSION} -gt 0 ]] && docker tag $IMAGE_NAME $IMAGE_NAME:$MAJOR_VERSION
+
+          docker push $IMAGE_NAME

.github/workflows/update-dep.yml

@@ -0,0 +1,31 @@
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 1 * * 4'
+jobs:
+  update-dep:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Update dependencies
+        run: |
+          npx -p npm-check-updates ncu -u
+          npm install
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+            token: ${{ secrets.ACTIONS_BOT_TOKEN }}
+            commit-message: 'chore: update dependencies'
+            committer: GitHub <noreply@github.com>
+            author: actions-bot <actions-bot@users.noreply.github.com>
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies

.gitignore

@@ -0,0 +1,2 @@
+lib/
+node_modules/

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid",
+  "parser": "typescript"
+}

Dockerfile

@@ -1,16 +1,18 @@
-FROM peterevans/curl-jq:1.0.1
+FROM node:12-alpine
 
-LABEL maintainer="Peter Evans <mail@peterevans.dev>"
-LABEL repository="https://github.com/peter-evans/dockerhub-description"
-LABEL homepage="https://github.com/peter-evans/dockerhub-description"
-
-LABEL com.github.actions.name="Docker Hub Description"
-LABEL com.github.actions.description="An action to update a Docker Hub repository description from README.md"
-LABEL com.github.actions.icon="upload"
-LABEL com.github.actions.color="blue"
+LABEL \
+  maintainer="Peter Evans <mail@peterevans.dev>" \
+  org.opencontainers.image.title="dockerhub-description" \
+  org.opencontainers.image.description="An action to update a Docker Hub repository description from README.md" \
+  org.opencontainers.image.authors="Peter Evans <mail@peterevans.dev>" \
+  org.opencontainers.image.url="https://github.com/peter-evans/dockerhub-description" \
+  org.opencontainers.image.vendor="https://peterevans.dev" \
+  org.opencontainers.image.licenses="MIT"
 
 COPY LICENSE README.md /
 
+COPY dist/index.js /index.js
+
 COPY entrypoint.sh /entrypoint.sh
 
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -10,45 +10,63 @@ 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
-      env:
-        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: peterevans/dockerhub-description
 ```
 
-#### Required environment variables
+### Action inputs
 
-- `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**: 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 2FA on Docker Hub will prevent the action from working.
 
-**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.
+| Name | Description | Default |
+| --- | --- | --- |
+| `username` | (**required**) Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository. | |
+| `password` | (**required**) Docker Hub password. | |
+| `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
+| `short-description` | Docker Hub repository short description. Input exceeding 100 characters will be truncated. | |
+| `readme-filepath` | Path to the repository readme. | `./README.md` |
 
-#### Optionally specifying the file path
+#### 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.
+If this is not the case the path can be specified with the `readme-filepath` input.
 
 ```yml
     - 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
-        README_FILEPATH: ./some-path/README.md
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: peterevans/dockerhub-description
+        readme-filepath: ./path/to/README.md
 ```
 
-#### Examples
+#### Using the GitHub repository description
 
-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`.
+The GitHub repository description can be used for the Docker Hub `short-descripton` by passing the description from the event context.
+
+```yml
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v2
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: peterevans/dockerhub-description
+        short-description: ${{ github.event.repository.description }}
+```
+
+### Examples
+
+The following workflow updates the Docker Hub repository description whenever there are changes to `README.md` and the workflow file itself on the `main` branch. This workflow assumes its location to be `.github/workflows/dockerhub-description.yml`.
 
 ```yml
 name: Update Docker Hub Description
 on:
   push:
     branches:
-      - master
+      - main
     paths:
       - README.md
       - .github/workflows/dockerhub-description.yml
@@ -57,12 +75,14 @@ jobs:
     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
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: peterevans/dockerhub-description
+        short-description: ${{ github.event.repository.description }}
 ```
 
 Updates the Docker Hub repository description whenever a new release is created.
@@ -75,12 +95,14 @@ jobs:
     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
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: peterevans/dockerhub-description
+        short-description: ${{ github.event.repository.description }}
 ```
 
 ## Using the Docker image independently of GitHub Actions
@@ -94,7 +116,7 @@ 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.2
+  peterevans/dockerhub-description:2
 ```
 
 ## License

action.yml

@@ -1,22 +1,28 @@
 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
+inputs:
+  username:
+    description: Docker Hub username
+    required: true
+  password:
+    description: Docker Hub password
+    required: true
+  repository:
+    description: >
+      Docker Hub repository in the format `<namespace>/<name>`
+      Default: `github.repository`
+  short-description:
+    description: >
+      Docker Hub repository short description
+      Input exceeding 100 characters will be truncated
+  readme-filepath:
+    description: >
+      Path to the repository readme
+      Default: `./README.md`
 runs:
-  using: 'docker'
-  image: 'docker://peterevans/dockerhub-description:2.2.0'
+  using: 'node12'
+  main: 'dist/index.js'
 branding:
   icon: 'upload'
   color: 'blue'

entrypoint.sh

@@ -2,48 +2,12 @@
 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}}
+# Execute the action code and output to file
+node index.js > action.log 2>&1
 
-# If the repository isn't explicitly defined, infer it from GitHub if possible
-DOCKERHUB_REPOSITORY=${DOCKERHUB_REPOSITORY:-${GITHUB_REPOSITORY}}
+# Remove lines containing sensitive information from the log
+sed -i '/::debug::/d' ./action.log
+sed -i '/::add-mask::/d' ./action.log
 
-# 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}\"}"
-TOKEN=$(curl -s -H "Content-Type: application/json" -X POST -d ${LOGIN_PAYLOAD} https://hub.docker.com/v2/users/login/ | jq -r .token)
-
-# Send a PATCH request to update the description of the repository
-echo "Sending PATCH request"
-REPO_URL="https://hub.docker.com/v2/repositories/${DOCKERHUB_REPOSITORY}/"
-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
-  exit 0
-else
-  exit 1
-fi
+# Output the log
+cat action.log

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  clearMocks: true,
+  moduleFileExtensions: ['js', 'ts'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true
+}

package.json

@@ -0,0 +1,48 @@
+{
+  "name": "dockerhub-description",
+  "version": "3.0.0",
+  "private": true,
+  "description": "An action to update a Docker Hub repository description from README.md",
+  "main": "lib/main.js",
+  "scripts": {
+    "build": "tsc && ncc build",
+    "format": "prettier --write '**/*.ts'",
+    "format-check": "prettier --check '**/*.ts'",
+    "lint": "eslint src/**/*.ts",
+    "test": "jest --passWithNoTests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peter-evans/dockerhub-description.git"
+  },
+  "keywords": [
+    "actions",
+    "dockerhub",
+    "description"
+  ],
+  "author": "Peter Evans",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/peter-evans/dockerhub-description/issues"
+  },
+  "homepage": "https://github.com/peter-evans/dockerhub-description#readme",
+  "dependencies": {
+    "@actions/core": "1.3.0",
+    "node-fetch": "2.6.1"
+  },
+  "devDependencies": {
+    "@types/jest": "26.0.23",
+    "@types/node": "15.6.1",
+    "@typescript-eslint/parser": "4.25.0",
+    "@vercel/ncc": "0.28.6",
+    "eslint": "7.27.0",
+    "eslint-plugin-github": "4.1.3",
+    "eslint-plugin-jest": "24.3.6",
+    "jest": "27.0.1",
+    "jest-circus": "27.0.1",
+    "js-yaml": "4.1.0",
+    "prettier": "2.3.0",
+    "ts-jest": "27.0.1",
+    "typescript": "4.3.2"
+  }
+}

src/dockerhub-helper.ts

@@ -0,0 +1,53 @@
+import * as core from '@actions/core'
+import * as fetch from 'node-fetch'
+
+const DESCRIPTION_MAX_CHARS = 100
+
+export async function getToken(
+  username: string,
+  password: string
+): Promise<string> {
+  const body = {
+    username: username,
+    password: password
+  }
+  const response = await fetch('https://hub.docker.com/v2/users/login', {
+    method: 'post',
+    body: JSON.stringify(body),
+    headers: {'Content-Type': 'application/json'}
+  })
+  if (!response.ok) {
+    throw new Error(
+      `Unexpected response: ${response.status} ${response.statusText}`
+    )
+  }
+  const json = await response.json()
+  core.setSecret(json['token'])
+  return json['token']
+}
+
+export async function updateRepositoryDescription(
+  token: string,
+  repository: string,
+  description: string,
+  fullDescription: string
+): Promise<void> {
+  const body = {
+    full_description: fullDescription
+  }
+  if (description) {
+    body['description'] = description.slice(0, DESCRIPTION_MAX_CHARS)
+  }
+  await fetch(`https://hub.docker.com/v2/repositories/${repository}`, {
+    method: 'patch',
+    body: JSON.stringify(body),
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `JWT ${token}`
+    }
+  }).then(res => {
+    if (!res.ok) {
+      throw new Error(res.statusText)
+    }
+  })
+}

src/input-helper.ts

@@ -0,0 +1,76 @@
+import * as core from '@actions/core'
+
+const README_FILEPATH_DEFAULT = './README.md'
+
+interface Inputs {
+  username: string
+  password: string
+  repository: string
+  shortDescription: string
+  readmeFilepath: string
+}
+
+export function getInputs(): Inputs {
+  const inputs = {
+    username: core.getInput('username'),
+    password: core.getInput('password'),
+    repository: core.getInput('repository'),
+    shortDescription: core.getInput('short-description'),
+    readmeFilepath: core.getInput('readme-filepath')
+  }
+
+  // Environment variable input alternatives and their aliases
+
+  if (!inputs.username && process.env['DOCKERHUB_USERNAME']) {
+    inputs.username = process.env['DOCKERHUB_USERNAME']
+  }
+  if (!inputs.username && process.env['DOCKER_USERNAME']) {
+    inputs.username = process.env['DOCKER_USERNAME']
+  }
+
+  if (!inputs.password && process.env['DOCKERHUB_PASSWORD']) {
+    inputs.password = process.env['DOCKERHUB_PASSWORD']
+  }
+  if (!inputs.password && process.env['DOCKER_PASSWORD']) {
+    inputs.password = process.env['DOCKER_PASSWORD']
+  }
+
+  if (!inputs.repository && process.env['DOCKERHUB_REPOSITORY']) {
+    inputs.repository = process.env['DOCKERHUB_REPOSITORY']
+  }
+  if (!inputs.repository && process.env['DOCKER_REPOSITORY']) {
+    inputs.repository = process.env['DOCKER_REPOSITORY']
+  }
+
+  if (!inputs.shortDescription && process.env['SHORT_DESCRIPTION']) {
+    inputs.shortDescription = process.env['SHORT_DESCRIPTION']
+  }
+
+  if (!inputs.readmeFilepath && process.env['README_FILEPATH']) {
+    inputs.readmeFilepath = process.env['README_FILEPATH']
+  }
+
+  // Set defaults
+  if (!inputs.readmeFilepath) {
+    inputs.readmeFilepath = README_FILEPATH_DEFAULT
+  }
+  if (!inputs.repository && process.env['GITHUB_REPOSITORY']) {
+    inputs.repository = process.env['GITHUB_REPOSITORY']
+  }
+
+  // Docker repositories must be all lower case
+  inputs.repository = inputs.repository.toLowerCase()
+
+  return inputs
+}
+
+function checkRequiredInput(input: string, name: string): void {
+  if (!input) {
+    throw new Error(`Required input '${name}' is missing.`)
+  }
+}
+
+export function validateInputs(inputs: Inputs): void {
+  checkRequiredInput(inputs.username, 'username')
+  checkRequiredInput(inputs.password, 'password')
+}

src/main.ts

@@ -0,0 +1,48 @@
+import * as core from '@actions/core'
+import * as inputHelper from './input-helper'
+import * as dockerhubHelper from './dockerhub-helper'
+import * as fs from 'fs'
+import {inspect, TextEncoder} from 'util'
+
+const MAX_BYTES = 25000
+
+async function run(): Promise<void> {
+  try {
+    const inputs = inputHelper.getInputs()
+    core.debug(`Inputs: ${inspect(inputs)}`)
+
+    inputHelper.validateInputs(inputs)
+
+    // Fetch the readme content
+    const readmeContent = await fs.promises.readFile(inputs.readmeFilepath, {
+      encoding: 'utf8'
+    })
+    const byteLength = new TextEncoder().encode(readmeContent).length
+    if (byteLength > MAX_BYTES) {
+      throw new Error(
+        `File size exceeds the maximum allowed ${MAX_BYTES} bytes`
+      )
+    }
+
+    // Acquire a token for the Docker Hub API
+    core.info('Acquiring token')
+    const token = await dockerhubHelper.getToken(
+      inputs.username,
+      inputs.password
+    )
+    // Send a PATCH request to update the description of the repository
+    core.info('Sending PATCH request')
+    await dockerhubHelper.updateRepositoryDescription(
+      token,
+      inputs.repository,
+      inputs.shortDescription,
+      readmeContent
+    )
+    core.info('Request successful')
+  } catch (error) {
+    core.debug(inspect(error))
+    core.setFailed(error.message)
+  }
+}
+
+run()

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "lib": [
+      "es6"
+    ],
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "declaration": true,
+    "strict": true,
+    "noImplicitAny": false,
+    "esModuleInterop": true
+  },
+  "exclude": ["__test__", "lib", "node_modules"]
+}