feat: truncate content exceeding the byte limit (#129)

Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 5.53.0 to 5.54.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.54.0/packages/parser)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/parser"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.eslintrc.json

@@ -9,8 +9,7 @@
     "plugin:import/errors",
     "plugin:import/warnings",
     "plugin:import/typescript",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
+    "plugin:prettier/recommended"
   ],
   "plugins": ["@typescript-eslint"],
   "rules": {

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: peter-evans

.github/dependabot.yml

@@ -0,0 +1,21 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+    labels:
+      - "dependencies"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]
+    labels:
+      - "dependencies"
+ 

.github/workflows/automerge-dependabot.yml

@@ -0,0 +1,13 @@
+name: Auto-merge Dependabot
+on: pull_request
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - uses: peter-evans/enable-pull-request-automerge@v2
+        with:
+          token: ${{ secrets.ACTIONS_BOT_TOKEN }}
+          pull-request-number: ${{ github.event.pull_request.number }}
+          merge-method: squash

.github/workflows/ci.yml

@@ -1,33 +1,39 @@
 name: CI
 on:
   push:
-    branches: [master]
+    branches: [main]
     paths-ignore:
       - 'README.md'
       - 'docs/**'
   pull_request:
-    branches: [master]
+    branches: [main]
     paths-ignore:
       - 'README.md'
       - 'docs/**'
+
+permissions:
+  pull-requests: write
+  contents: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 12.x
+          node-version: 16.x
+          cache: npm
       - 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
+      - uses: actions/upload-artifact@v3
         with:
           name: dist
           path: dist
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           name: action.yml
           path: action.yml
@@ -40,14 +46,14 @@ jobs:
       matrix:
         target: [built, committed]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - if: matrix.target == 'built' || github.event_name == 'pull_request'
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: dist
           path: dist
       - if: matrix.target == 'built' || github.event_name == 'pull_request'
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: action.yml
           path: .
@@ -76,22 +82,23 @@ jobs:
           DOCKERHUB_REPOSITORY: peterevans/dd-ci-fixture-${{ matrix.target }}
 
   package:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    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
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
         with:
           name: dist
           path: dist
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v4
         with:
+          token: ${{ secrets.ACTIONS_BOT_TOKEN }}
           commit-message: 'build: update distribution'
           title: Update distribution
           body: |
-            - Updates the distribution for changes on `master`
+            - Updates the distribution for changes on `main`
 
             Auto-generated by [create-pull-request][1]
 

.github/workflows/dockerhub-description.yml

@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - master
+      - main
     paths:
       - README.md
       - .github/workflows/dockerhub-description.yml
@@ -11,12 +11,12 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Modify readme for DockerHub
         run: |
           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
+          sed -i 's/(LICENSE)/(https:\/\/github.com\/peter-evans\/dockerhub-description\/blob\/main\/LICENSE)/' README.md
 
       - name: Docker Hub Description
         uses: ./
@@ -24,3 +24,4 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_PASSWORD }}
           repository: peterevans/dockerhub-description
+          short-description: ${{ github.event.repository.description }}

.github/workflows/publish-docker.yml

@@ -2,7 +2,7 @@ name: Publish Docker Image
 on:
   push:
     branches:
-      - master
+      - main
     tags:
       - v*
 env:
@@ -11,7 +11,7 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Docker Hub login
         run: echo "${{ secrets.DOCKERHUB_PASSWORD }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin
@@ -25,7 +25,7 @@ jobs:
           [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
 
           # Use Docker `latest` tag convention
-          [ "$VERSION" == "master" ] && VERSION=latest
+          [ "$VERSION" == "main" ] && VERSION=latest
 
           # Build and tag image
           docker build . --file Dockerfile --tag $IMAGE_NAME --label "org.opencontainers.image.version=$VERSION"
@@ -38,4 +38,4 @@ jobs:
           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
+          docker push $IMAGE_NAME --all-tags

.github/workflows/update-dep.yml

@@ -1,31 +0,0 @@
-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

.github/workflows/update-major-version.yml

@@ -0,0 +1,31 @@
+name: Update Major Version
+run-name: Update ${{ github.event.inputs.main_version }} to ${{ github.event.inputs.target }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      target:
+        description: The target tag or reference
+        required: true
+      main_version:
+        type: choice
+        description: The major version tag to update
+        options:
+          - v3
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        token: ${{ secrets.ACTIONS_BOT_TOKEN }}
+        fetch-depth: 0
+    - name: Git config
+      run: |
+        git config user.name actions-bot
+        git config user.email actions-bot@users.noreply.github.com
+    - name: Tag new target
+      run: git tag -f ${{ github.event.inputs.main_version }} ${{ github.event.inputs.target }}
+    - name: Push new tag
+      run: git push origin ${{ github.event.inputs.main_version }} --force

README.md

@@ -9,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
+      uses: peter-evans/dockerhub-description@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -18,15 +18,22 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 ### Action inputs
 
-**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.
-
 | 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. | |
+| `password` | (**required**) Docker Hub password or [Personal Access Token](https://docs.docker.com/docker-hub/access-tokens/) with `read/write/delete` scope. | |
 | `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. | |
+| `short-description` | Docker Hub repository short description. | |
 | `readme-filepath` | Path to the repository readme. | `./README.md` |
+| `enable-url-completion` | Enables completion of relative URLs to absolute ones. See also [known Issues](#url-completion-known-issues). | `false` |
+| `image-extensions` | File extensions that will be treated as images. | `bmp,gif,jpg,jpeg,png,svg,webp` |
+
+#### Content limits
+
+DockerHub has content limits.
+The readme content is limited to 25,000 bytes, and `short-description` is limited to 100 characters.
+This action truncates content to prevent the request being rejected.
+If the content has been truncated a warning will be issued in the run log.
 
 #### Specifying the file path
 
@@ -35,7 +42,7 @@ If this is not the case the path can be specified with the `readme-filepath` inp
 
 ```yml
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2
+      uses: peter-evans/dockerhub-description@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -43,16 +50,30 @@ If this is not the case the path can be specified with the `readme-filepath` inp
         readme-filepath: ./path/to/README.md
 ```
 
+#### Using the GitHub repository description
+
+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@v3
+      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 `master` branch. This workflow assumes its location to be `.github/workflows/dockerhub-description.yml`.
+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
@@ -60,14 +81,16 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2
+      uses: peter-evans/dockerhub-description@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
         repository: peterevans/dockerhub-description
+        short-description: ${{ github.event.repository.description }}
+        enable-url-completion: true
 ```
 
 Updates the Docker Hub repository description whenever a new release is created.
@@ -79,16 +102,49 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2
+      uses: peter-evans/dockerhub-description@v3
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
         repository: peterevans/dockerhub-description
+        short-description: ${{ github.event.repository.description }}
 ```
 
+### URL completion known Issues
+
+The completion of relative URLs has some known issues:
+
+1. Relative markdown links in inline-code and code blocks **are also converted**:
+
+   ```markdown
+   [link in inline code](#table-of-content)
+   ```
+
+   will be converted into
+
+   ```markdown
+   [link in inline code](https://github.com/peter-evans/dockerhub-description/blob/main/./README.md#table-of-content)
+   ```
+
+2. Links containing square brackets (`]`) in the text fragment **are not converted**:
+
+   ```markdown
+   [[link text with square brackets]](#table-of-content)
+   ```
+
+3. [Reference-style links/images](https://www.markdownguide.org/basic-syntax/#reference-style-links) **are not converted**.
+
+   ```markdown
+   [table-of-content][toc]
+
+   ...
+
+   [toc]: #table-of-content "Table of content"
+   ```
+
 ## Using the Docker image independently of GitHub Actions
 
 The image can be executed in other environments independently of GitHub Actions.
@@ -100,7 +156,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
+  peterevans/dockerhub-description:3
 ```
 
 ## License

__test__/readme-helper.unit.test.ts

@@ -0,0 +1,344 @@
+import {completeRelativeUrls, truncateToBytes} from '../src/readme-helper'
+
+describe('complete relative urls tests', () => {
+  const GITHUB_SERVER_URL = process.env['GITHUB_SERVER_URL']
+  const GITHUB_REPOSITORY = process.env['GITHUB_REPOSITORY']
+  const GITHUB_REF_NAME = process.env['GITHUB_REF_NAME']
+
+  const README_FILEPATH = './README.md'
+  const EXPECTED_REPOSITORY_URL = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}`
+  const EXPECTED_BLOB_URL = `${EXPECTED_REPOSITORY_URL}/blob/${GITHUB_REF_NAME}`
+  const EXPECTED_RAW_URL = `${EXPECTED_REPOSITORY_URL}/raw/${GITHUB_REF_NAME}`
+
+  // known issues
+  test('reference-style links/image sources are not converted', async () => {
+    const content = [
+      'table-of-content][toc]',
+      '',
+      '[toc]: #table-of-content "Table of content"'
+    ].join('\n')
+    expect(completeRelativeUrls(content, README_FILEPATH, true, '')).toEqual(
+      content
+    )
+  })
+
+  test('links containing square brackets in the text fragment are not converted', async () => {
+    expect(
+      completeRelativeUrls(
+        '[[text with square brackets]](README.md)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual('[[text with square brackets]](README.md)')
+  })
+
+  test('links containing square brackets in the text fragment are not converted', async () => {
+    expect(
+      completeRelativeUrls('`[text](README.md)`', README_FILEPATH, true, '')
+    ).toEqual(`\`[text](${EXPECTED_BLOB_URL}/README.md)\``)
+  })
+
+  // misc
+  test('do not change content when disabled', async () => {
+    expect(
+      completeRelativeUrls('[text](README.md)', README_FILEPATH, false, '')
+    ).toEqual('[text](README.md)')
+  })
+
+  test('do not change link with mailto protocol', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](mailto:mail@example.com)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](mailto:mail@example.com)`)
+  })
+
+  test('do not change link with ftp protocol', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](ftp://example.com)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](ftp://example.com)`)
+  })
+
+  test('do not change link with http protocol', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](http://example.com)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](http://example.com)`)
+  })
+
+  test('do not change link with https protocol', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](https://example.com)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](https://example.com)`)
+  })
+
+  test('do not change link with protocol-like beginning', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](abc://example.com)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](abc://example.com)`)
+  })
+
+  test('do not change image from absolute source with absolute link', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](https://example.com/image.svg)](https://example.com/image.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](https://example.com/image.svg)](https://example.com/image.svg)`
+    )
+  })
+
+  // anchors
+  test('anchor referencing the current document', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](#relative-anchor)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](${EXPECTED_BLOB_URL}/README.md#relative-anchor)`)
+  })
+
+  test('anchor referencing the current document with a title', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](#relative-anchor "the anchor (a title)")',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(
+      `[text](${EXPECTED_BLOB_URL}/README.md#relative-anchor "the anchor (a title)")`
+    )
+  })
+
+  test('anchor referencing the current document with a title and unicode', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text with 🌬](#relative-anchor "the anchor (a title with 🌬)")',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(
+      `[text with 🌬](${EXPECTED_BLOB_URL}/README.md#relative-anchor "the anchor (a title with 🌬)")`
+    )
+  })
+
+  test('anchor referencing another document', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](OTHER.md#absolute-anchor)',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(`[text](${EXPECTED_BLOB_URL}/OTHER.md#absolute-anchor)`)
+  })
+
+  test('anchor referencing another document with a title', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](OTHER.md#absolute-anchor "the anchor (a title)")',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(
+      `[text](${EXPECTED_BLOB_URL}/OTHER.md#absolute-anchor "the anchor (a title)")`
+    )
+  })
+
+  test('anchor with image referencing the current document', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](image.svg)](#absolute-anchor "the anchor (a title)")',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](${EXPECTED_RAW_URL}/image.svg)](${EXPECTED_BLOB_URL}/README.md#absolute-anchor "the anchor (a title)")`
+    )
+  })
+
+  test('anchor with image referencing another document', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](image.svg)](OTHER.md#absolute-anchor "the anchor (a title)")',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](${EXPECTED_RAW_URL}/image.svg)](${EXPECTED_BLOB_URL}/OTHER.md#absolute-anchor "the anchor (a title)")`
+    )
+  })
+
+  // documents
+  test('text document', async () => {
+    expect(
+      completeRelativeUrls('[text](document.yaml)', README_FILEPATH, true, '')
+    ).toEqual(`[text](${EXPECTED_BLOB_URL}/document.yaml)`)
+  })
+
+  test('pdf document', async () => {
+    expect(
+      completeRelativeUrls('[text](document.pdf)', README_FILEPATH, true, '')
+    ).toEqual(`[text](${EXPECTED_BLOB_URL}/document.pdf)`)
+  })
+
+  test('document with a title', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text](document.pdf "the document (a title)")',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(
+      `[text](${EXPECTED_BLOB_URL}/document.pdf "the document (a title)")`
+    )
+  })
+
+  test('document with a title and unicode', async () => {
+    expect(
+      completeRelativeUrls(
+        '[text with 🌬](document.pdf "the document (a title with 🌬)")',
+        README_FILEPATH,
+        true,
+        ''
+      )
+    ).toEqual(
+      `[text with 🌬](${EXPECTED_BLOB_URL}/document.pdf "the document (a title with 🌬)")`
+    )
+  })
+
+  // images
+  test('image with supported file extension', async () => {
+    expect(
+      completeRelativeUrls(
+        '![alttext](image.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(`![alttext](${EXPECTED_RAW_URL}/image.svg)`)
+  })
+
+  test('image with unsupported file extension', async () => {
+    expect(
+      completeRelativeUrls(
+        '![alttext](image.svg)',
+        README_FILEPATH,
+        true,
+        'jpeg'
+      )
+    ).toEqual(`![alttext](${EXPECTED_BLOB_URL}/image.svg)`)
+  })
+
+  test('image without alternate text', async () => {
+    expect(
+      completeRelativeUrls('![](image.svg)', README_FILEPATH, true, 'svg')
+    ).toEqual(`![](${EXPECTED_RAW_URL}/image.svg)`)
+  })
+
+  test('image with a title', async () => {
+    expect(
+      completeRelativeUrls(
+        '![alttext](image.svg "the image (a title)")',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(`![alttext](${EXPECTED_RAW_URL}/image.svg "the image (a title)")`)
+  })
+
+  test('image with relative link', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](image.svg)](image.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](${EXPECTED_RAW_URL}/image.svg)](${EXPECTED_BLOB_URL}/image.svg)`
+    )
+  })
+
+  test('image with a title, unicode and relative link', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext with 🌬](image.🌬.svg "the image.🌬.svg (a title)")](image.🌬.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext with 🌬](${EXPECTED_RAW_URL}/image.🌬.svg "the image.🌬.svg (a title)")](${EXPECTED_BLOB_URL}/image.🌬.svg)`
+    )
+  })
+
+  test('image from absolute source with relative link', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](https://example.com/image.svg)](image.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](https://example.com/image.svg)](${EXPECTED_BLOB_URL}/image.svg)`
+    )
+  })
+
+  test('image with absolute link', async () => {
+    expect(
+      completeRelativeUrls(
+        '[![alttext](image.svg)](https://example.com/image.svg)',
+        README_FILEPATH,
+        true,
+        'svg'
+      )
+    ).toEqual(
+      `[![alttext](${EXPECTED_RAW_URL}/image.svg)](https://example.com/image.svg)`
+    )
+  })
+})
+
+describe('truncate to bytes tests', () => {
+  test('unicode aware truncation to a number of bytes', async () => {
+    expect(truncateToBytes('test string to be truncated', 10)).toEqual(
+      'test strin'
+    )
+    expect(truncateToBytes('😀😁😂🤣😃😄😅', 10)).toEqual('😀😁')
+  })
+})

action.yml

@@ -6,22 +6,28 @@ inputs:
     description: Docker Hub username
     required: true
   password:
-    description: Docker Hub password
+    description: Docker Hub password or Personal Access Token with read/write/delete scope
     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
+    description: Docker Hub repository short description
   readme-filepath:
     description: >
       Path to the repository readme
       Default: `./README.md`
+  enable-url-completion:
+    description: >
+      Enables completion of relative URLs to absolute ones
+      Default: `false`
+  image-extensions:
+    description: >
+      File extensions that will be treated as images
+      Default: `bmp,gif,jpg,jpeg,png,svg,webp`
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'dist/index.js'
 branding:
   icon: 'upload'

jest.config.js

@@ -9,3 +9,8 @@ module.exports = {
   },
   verbose: true
 }
+process.env = Object.assign(process.env, {
+  GITHUB_SERVER_URL: 'https://github.com',
+  GITHUB_REPOSITORY: 'peter-evans/dockerhub-description',
+  GITHUB_REF_NAME: 'main'
+})

package.json

@@ -9,7 +9,7 @@
     "format": "prettier --write '**/*.ts'",
     "format-check": "prettier --check '**/*.ts'",
     "lint": "eslint src/**/*.ts",
-    "test": "jest --passWithNoTests"
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -27,22 +27,23 @@
   },
   "homepage": "https://github.com/peter-evans/dockerhub-description#readme",
   "dependencies": {
-    "@actions/core": "1.2.6",
-    "node-fetch": "2.6.1"
+    "@actions/core": "^1.10.0",
+    "node-fetch": "^2.6.9",
+    "unicode-substring": "^0.1.0"
   },
   "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"
+    "@types/jest": "^27.0.3",
+    "@types/node": "^16.18.14",
+    "@typescript-eslint/parser": "^5.54.0",
+    "@vercel/ncc": "^0.36.1",
+    "eslint": "^8.35.0",
+    "eslint-plugin-github": "^4.6.1",
+    "eslint-plugin-jest": "^25.7.0",
+    "jest": "^27.5.1",
+    "jest-circus": "^27.5.1",
+    "js-yaml": "^4.1.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^27.1.5",
+    "typescript": "^4.9.5"
   }
 }

src/dockerhub-helper.ts

@@ -16,6 +16,11 @@ export async function getToken(
     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']

src/input-helper.ts

@@ -1,6 +1,5 @@
 import * as core from '@actions/core'
-
-const README_FILEPATH_DEFAULT = './README.md'
+import * as readmeHelper from './readme-helper'
 
 interface Inputs {
   username: string
@@ -8,6 +7,8 @@ interface Inputs {
   repository: string
   shortDescription: string
   readmeFilepath: string
+  enableUrlCompletion: boolean
+  imageExtensions: string
 }
 
 export function getInputs(): Inputs {
@@ -16,7 +17,9 @@ export function getInputs(): Inputs {
     password: core.getInput('password'),
     repository: core.getInput('repository'),
     shortDescription: core.getInput('short-description'),
-    readmeFilepath: core.getInput('readme-filepath')
+    readmeFilepath: core.getInput('readme-filepath'),
+    enableUrlCompletion: Boolean(core.getInput('enable-url-completion')),
+    imageExtensions: core.getInput('image-extensions')
   }
 
   // Environment variable input alternatives and their aliases
@@ -50,14 +53,32 @@ export function getInputs(): Inputs {
     inputs.readmeFilepath = process.env['README_FILEPATH']
   }
 
+  if (!inputs.enableUrlCompletion && process.env['ENABLE_URL_COMPLETION']) {
+    inputs.enableUrlCompletion = Boolean(process.env['ENABLE_URL_COMPLETION'])
+  }
+
+  if (!inputs.imageExtensions && process.env['IMAGE_EXTENSIONS']) {
+    inputs.imageExtensions = process.env['IMAGE_EXTENSIONS']
+  }
+
   // Set defaults
   if (!inputs.readmeFilepath) {
-    inputs.readmeFilepath = README_FILEPATH_DEFAULT
+    inputs.readmeFilepath = readmeHelper.README_FILEPATH_DEFAULT
+  }
+  if (!inputs.enableUrlCompletion) {
+    inputs.enableUrlCompletion = readmeHelper.ENABLE_URL_COMPLETION_DEFAULT
+  }
+  if (!inputs.imageExtensions) {
+    inputs.imageExtensions = readmeHelper.IMAGE_EXTENSIONS_DEFAULT
   }
   if (!inputs.repository && process.env['GITHUB_REPOSITORY']) {
     inputs.repository = process.env['GITHUB_REPOSITORY']
   }
 
+  // Enforce lower case, where needed
+  inputs.repository = inputs.repository.toLowerCase()
+  inputs.imageExtensions = inputs.imageExtensions.toLowerCase()
+
   return inputs
 }
 

src/main.ts

@@ -1,10 +1,13 @@
 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'
+import * as readmeHelper from './readme-helper'
+import {inspect} from 'util'
 
-const MAX_BYTES = 25000
+function getErrorMessage(error: unknown) {
+  if (error instanceof Error) return error.message
+  return String(error)
+}
 
 async function run(): Promise<void> {
   try {
@@ -14,15 +17,13 @@ async function run(): Promise<void> {
     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`
-      )
-    }
+    core.info('Reading description source file')
+    const readmeContent = await readmeHelper.getReadmeContent(
+      inputs.readmeFilepath,
+      inputs.enableUrlCompletion,
+      inputs.imageExtensions
+    )
+    core.debug(readmeContent)
 
     // Acquire a token for the Docker Hub API
     core.info('Acquiring token')
@@ -41,7 +42,7 @@ async function run(): Promise<void> {
     core.info('Request successful')
   } catch (error) {
     core.debug(inspect(error))
-    core.setFailed(error.message)
+    core.setFailed(getErrorMessage(error))
   }
 }
 

src/readme-helper.ts

@@ -0,0 +1,193 @@
+import * as core from '@actions/core'
+import * as fs from 'fs'
+import unicodeSubstring = require('unicode-substring')
+
+export const README_FILEPATH_DEFAULT = './README.md'
+export const IMAGE_EXTENSIONS_DEFAULT = 'bmp,gif,jpg,jpeg,png,svg,webp'
+export const ENABLE_URL_COMPLETION_DEFAULT = false
+
+const TITLE_REGEX = `(?: +"[^"]+")?`
+const REPOSITORY_URL = `${process.env['GITHUB_SERVER_URL']}/${process.env['GITHUB_REPOSITORY']}`
+const BLOB_PREFIX = `${REPOSITORY_URL}/blob/${process.env['GITHUB_REF_NAME']}/`
+const RAW_PREFIX = `${REPOSITORY_URL}/raw/${process.env['GITHUB_REF_NAME']}/`
+
+const MAX_BYTES = 25000
+
+type Rule = {
+  /**
+   * all left of the relative url belonging to the markdown image/link
+   */
+  left: RegExp
+  /**
+   * relative url
+   */
+  url: RegExp
+  /**
+   * part to prefix the relative url with (excluding github repository url)
+   */
+  absUrlPrefix: string
+}
+
+export function truncateToBytes(s: string, n: number): string {
+  let len = n
+  while (Buffer.byteLength(s) > n) {
+    s = unicodeSubstring(s, 0, len--)
+  }
+  return s
+}
+
+export async function getReadmeContent(
+  readmeFilepath: string,
+  enableUrlCompletion: boolean,
+  imageExtensions: string
+): Promise<string> {
+  // Fetch the readme content
+  let readmeContent = await fs.promises.readFile(readmeFilepath, {
+    encoding: 'utf8'
+  })
+
+  readmeContent = completeRelativeUrls(
+    readmeContent,
+    readmeFilepath,
+    enableUrlCompletion,
+    imageExtensions
+  )
+
+  const truncatedReadmeContent = truncateToBytes(readmeContent, MAX_BYTES)
+  if (truncatedReadmeContent.length !== readmeContent.length) {
+    core.warning(
+      `The README content exceeds DockerHub's limit and has been truncated to ${MAX_BYTES} bytes.`
+    )
+  }
+
+  return truncatedReadmeContent
+}
+
+export function completeRelativeUrls(
+  readmeContent: string,
+  readmeFilepath: string,
+  enableUrlCompletion: boolean,
+  imageExtensions: string
+): string {
+  if (enableUrlCompletion) {
+    readmeFilepath = readmeFilepath.replace(/^[.][/]/, '')
+
+    // Make relative urls absolute
+    const rules = [
+      ...getRelativeReadmeAnchorsRules(readmeFilepath),
+      ...getRelativeImageUrlRules(imageExtensions),
+      ...getRelativeUrlRules()
+    ]
+
+    readmeContent = applyRules(rules, readmeContent)
+  }
+
+  return readmeContent
+}
+
+function applyRules(rules: Rule[], readmeContent: string): string {
+  rules.forEach(rule => {
+    const combinedRegex = `${rule.left.source}[(]${rule.url.source}[)]`
+    core.debug(`rule: ${combinedRegex}`)
+
+    const replacement = `$<left>(${rule.absUrlPrefix}$<url>)`
+    core.debug(`replacement: ${replacement}`)
+
+    readmeContent = readmeContent.replace(
+      new RegExp(combinedRegex, 'giu'),
+      replacement
+    )
+  })
+
+  return readmeContent
+}
+
+// has to be applied first to avoid wrong results
+function getRelativeReadmeAnchorsRules(readmeFilepath: string): Rule[] {
+  const prefix = `${BLOB_PREFIX}${readmeFilepath}`
+
+  // matches e.g.:
+  //    #table-of-content
+  //    #table-of-content "the anchor (a title)"
+  const url = new RegExp(`(?<url>#[^)]+${TITLE_REGEX})`)
+
+  const rules: Rule[] = [
+    // matches e.g.:
+    //    [#table-of-content](#table-of-content)
+    //    [#table-of-content](#table-of-content "the anchor (a title)")
+    {
+      left: /(?<left>\[[^\]]+\])/,
+      url: url,
+      absUrlPrefix: prefix
+    },
+
+    // matches e.g.:
+    //    [![media/image.svg](media/image.svg)](#table-of-content)
+    //    [![media/image.svg](media/image.svg "title a")](#table-of-content "title b")
+    {
+      left: /(?<left>\[!\[[^\]]*\]\([^)]+\)\])/,
+      url: url,
+      absUrlPrefix: prefix
+    }
+  ]
+
+  return rules
+}
+
+function getRelativeImageUrlRules(imageExtensions: string): Rule[] {
+  const extensionsRegex = imageExtensions.replace(/,/g, '|')
+  // matches e.g.:
+  //    media/image.svg
+  //    media/image.svg "with title"
+  const url = new RegExp(
+    `(?<url>[^:)]+[.](?:${extensionsRegex})${TITLE_REGEX})`
+  )
+
+  const rules: Rule[] = [
+    // matches e.g.:
+    //    ![media/image.svg](media/image.svg)
+    //    ![media/image.svg](media/image.svg "with title")
+    {
+      left: /(?<left>!\[[^\]]*\])/,
+      url: url,
+      absUrlPrefix: RAW_PREFIX
+    }
+  ]
+
+  return rules
+}
+
+function getRelativeUrlRules(): Rule[] {
+  // matches e.g.:
+  //    .releaserc.yaml
+  //    README.md#table-of-content "title b"
+  //    .releaserc.yaml "the .releaserc.yaml file (a title)"
+  const url = new RegExp(`(?<url>[^:)]+${TITLE_REGEX})`)
+
+  const rules: Rule[] = [
+    // matches e.g.:
+    //    [.releaserc.yaml](.releaserc.yaml)
+    //    [.releaserc.yaml](.releaserc.yaml "the .releaserc.yaml file (a title)")
+    {
+      left: /(?<left>\[[^\]]+\])/,
+      url: url,
+      absUrlPrefix: BLOB_PREFIX
+    },
+
+    // matches e.g.:
+    //    [![media/image.svg](media/image.svg)](media/image.svg)
+    //    [![media/image.svg](media/image.svg)](README.md#table-of-content "title b")
+    //    [![media/image.svg](media/image.svg "title a")](media/image.svg)
+    //    [![media/image.svg](media/image.svg "title a")](media/image.svg "title b")
+    //    [![media/image.svg](media/image.svg "title a")](README.md#table-of-content "title b")
+    {
+      left: new RegExp(
+        `(?<left>\\[!\\[[^\\]]*\\]\\([^)]+${TITLE_REGEX}\\)\\])`
+      ),
+      url: url,
+      absUrlPrefix: BLOB_PREFIX
+    }
+  ]
+
+  return rules
+}