Merge pull request #71 from peter-evans/rm-byte-limit

feat: remove error when content limit exceeded

.github/workflows/ci.yml

@@ -86,7 +86,7 @@ jobs:
           name: dist
           path: dist
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v4
         with:
           commit-message: 'build: update distribution'
           title: Update distribution

README.md

@@ -18,16 +18,19 @@ 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` |
 
+#### Content limits
+
+DockerHub has content limits, which if exceeded will result in the content being automatically truncated.
+The readme content is limited to 25,000 bytes, and `short-description` is limited to 100 characters.
+
 #### Specifying the file path
 
 The action assumes that there is a file called `README.md` located at the root of the repository.

action.yml

@@ -6,16 +6,14 @@ 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

dist/index.js

@@ -212,7 +212,6 @@ const inputHelper = __importStar(__nccwpck_require__(480));
 const dockerhubHelper = __importStar(__nccwpck_require__(812));
 const fs = __importStar(__nccwpck_require__(147));
 const util_1 = __nccwpck_require__(837);
-const MAX_BYTES = 25000;
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -223,10 +222,6 @@ function run() {
             const readmeContent = yield fs.promises.readFile(inputs.readmeFilepath, {
                 encoding: 'utf8'
             });
-            const byteLength = new util_1.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 = yield dockerhubHelper.getToken(inputs.username, inputs.password);

src/main.ts

@@ -2,9 +2,7 @@ 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
+import {inspect} from 'util'
 
 async function run(): Promise<void> {
   try {
@@ -17,12 +15,6 @@ async function run(): Promise<void> {
     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')