refactor: convert to typescript

.eslintignore

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

.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "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",
+    "prettier/@typescript-eslint"
+  ],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/camelcase": "off"
+  }
+}

.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+on:
+  push:
+    branches: [master]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+  pull_request:
+    branches: [master]
+    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
+          mv README.md some/path/TEST.md
+
+      # - name: Docker Hub Description
+      #   uses: ./
+      #   with:
+      #     dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
+      #     dockerhub-password: ${{ secrets.DOCKERHUB_PASSWORD }}
+      #     dockerhub-repository: peterevans/dd-ci-fixture-${{ matrix.target }}
+      #     readme-filepath: ./some/path/TEST.md
+
+      - name: Docker Hub Description
+        uses: ./
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+          DOCKERHUB_REPOSITORY: peterevans/dd-ci-fixture-${{ matrix.target }}
+          README_FILEPATH: ./some/path/TEST.md
+
+  package:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    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: Update distribution
+          title: Update distribution
+          body: |
+            - Updates the distribution for changes on `master`
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: update-distribution

.github/workflows/dockerhub-description.yml

@@ -18,15 +18,9 @@ jobs:
           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\/master\/LICENSE)/' README.md
 
-      - name: Test non-default filepath
-        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
+        with:
+          dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
+          dockerhub-password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          dockerhub-repository: peterevans/dockerhub-description

.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: 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"
+}

action.yml

@@ -1,22 +1,21 @@
 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:
+  dockerhub-username:
+    description: Docker Hub username
+    required: true
+  dockerhub-password:
+    description: Docker Hub password
+    required: true
+  dockerhub-repository:
+    description: Docker Hub repository to update in the format `<namespace>/<name>`
+    required: true
+  readme-filepath:
+    description: Path to the repository readme. Defaults to `./README.md`.
 runs:
-  using: 'docker'
-  image: 'docker://peterevans/dockerhub-description:2.3.1'
+  using: 'node12'
+  main: 'dist/index.js'
 branding:
   icon: 'upload'
   color: 'blue'

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.2.5",
+    "node-fetch": "2.6.1"
+  },
+  "devDependencies": {
+    "@types/jest": "26.0.14",
+    "@types/node": "14.10.3",
+    "@typescript-eslint/parser": "4.1.1",
+    "@vercel/ncc": "0.24.1",
+    "eslint": "7.9.0",
+    "eslint-plugin-github": "4.1.1",
+    "eslint-plugin-jest": "24.0.1",
+    "jest": "26.4.2",
+    "jest-circus": "26.4.2",
+    "js-yaml": "3.14.0",
+    "prettier": "2.1.2",
+    "ts-jest": "26.3.0",
+    "typescript": "4.0.2"
+  }
+}

src/dockerhub-helper.ts

@@ -0,0 +1,38 @@
+import * as core from '@actions/core'
+import * as fetch from 'node-fetch'
+
+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'}
+  })
+  const json = await response.json()
+  core.setSecret(json['token'])
+  return json['token']
+}
+
+export async function updateRepositoryDescription(
+  token: string,
+  repository: string,
+  fullDescription: string
+): Promise<void> {
+  const body = {
+    full_description: fullDescription
+  }
+  await fetch(`https://hub.docker.com/v2/repositories/${repository}`, {
+    method: 'patch',
+    body: JSON.stringify(body),
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `JWT ${token}`
+    }
+  })
+}

src/input-helper.ts

@@ -0,0 +1,68 @@
+import * as core from '@actions/core'
+
+const README_FILEPATH_DEFAULT = './README.md'
+
+interface Inputs {
+  dockerhubUsername: string
+  dockerhubPassword: string
+  dockerhubRepository: string
+  readmeFilepath: string
+}
+
+export function getInputs(): Inputs {
+  const inputs = {
+    dockerhubUsername: core.getInput('dockerhub-username'),
+    dockerhubPassword: core.getInput('dockerhub-password'),
+    dockerhubRepository: core.getInput('dockerhub-repository'),
+    readmeFilepath: core.getInput('readme-filepath')
+  }
+
+  // Environment variable input alternatives and their aliases
+
+  if (!inputs.dockerhubUsername && process.env['DOCKERHUB_USERNAME']) {
+    inputs.dockerhubUsername = process.env['DOCKERHUB_USERNAME']
+  }
+  if (!inputs.dockerhubUsername && process.env['DOCKER_USERNAME']) {
+    inputs.dockerhubUsername = process.env['DOCKER_USERNAME']
+  }
+
+  if (!inputs.dockerhubPassword && process.env['DOCKERHUB_PASSWORD']) {
+    inputs.dockerhubPassword = process.env['DOCKERHUB_PASSWORD']
+  }
+  if (!inputs.dockerhubPassword && process.env['DOCKER_PASSWORD']) {
+    inputs.dockerhubPassword = process.env['DOCKER_PASSWORD']
+  }
+
+  if (!inputs.dockerhubRepository && process.env['DOCKERHUB_REPOSITORY']) {
+    inputs.dockerhubRepository = process.env['DOCKERHUB_REPOSITORY']
+  }
+  if (!inputs.dockerhubRepository && process.env['DOCKER_REPOSITORY']) {
+    inputs.dockerhubRepository = process.env['DOCKER_REPOSITORY']
+  }
+  if (!inputs.dockerhubRepository && process.env['GITHUB_REPOSITORY']) {
+    inputs.dockerhubRepository = process.env['GITHUB_REPOSITORY']
+  }
+
+  if (!inputs.readmeFilepath && process.env['README_FILEPATH']) {
+    inputs.readmeFilepath = process.env['README_FILEPATH']
+  }
+
+  // Set defaults
+  if (!inputs.readmeFilepath) {
+    inputs.readmeFilepath = README_FILEPATH_DEFAULT
+  }
+
+  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.dockerhubUsername, 'dockerhub-username')
+  checkRequiredInput(inputs.dockerhubPassword, 'dockerhub-password')
+  checkRequiredInput(inputs.dockerhubRepository, 'dockerhub-repository')
+}

src/main.ts

@@ -0,0 +1,47 @@
+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.dockerhubUsername,
+      inputs.dockerhubPassword
+    )
+    // Send a PATCH request to update the description of the repository
+    core.info('Sending PATCH request')
+    await dockerhubHelper.updateRepositoryDescription(
+      token,
+      inputs.dockerhubRepository,
+      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"]
+}