peter-evans / dockerhub-description Goto Github PK

Just started using this since I had to migrate from Docker Hub builds, and discovered that the Dockerfile shown on Docker Hub is out of date on the repos where I'm using this. Is there any way to update the Dockerfile as well as the README?

Hey guys,
first thank you for this awesome project.
I've got the following problem:

My github action workflow configuration:

  - name: Update docker hub description
    uses: peter-evans/dockerhub-description@v2
    with:
      username: ${{ secrets.DOCKERHUB_USERNAME }} # --> rouhim
      password: ${{ secrets.DOCKERHUB_PASSWORD }}
      repository: rouhim/beammp-docker   # ---> gets replaced ***/beammp-docker

The output:

Run peter-evans/dockerhub-description@v2
  with:
    username: ***
    password: ***
    repository: ***/beammp-docker
Acquiring token
Sending PATCH request
Error: NOT FOUND

My best guess is that the github action replaces and breaks the repository path, because my github repository contains my dockerhub username.

Full github action setup: https://github.com/RouHim/beammp-docker/blob/main/.github/workflows/main.yml
According docherhub repo: https://hub.docker.com/r/rouhim/beammp-server

It seems that this GitHub Action has the same problem as others where you can't actually use a Docker Access Token as your account password is actually required, and if you have 2FA enabled on your account then it can't work.

As a followup to #22, which solved the problem of not seeing any error, I'm now getting response FORBIDDEN.

This is I guess as expected because i'm using a token as the password, which can not be used to acquire a token for obvious reasons. The reason however for using a token and not the password is that tokens are easy to revoke, and also prescribed in docker/login-action and docker/docker-push-action.

For now I will switch to using my users password, but it would be really nice to have the option to use either password or token as an input. Perhaps it could even auto-detect (say by the number of characters).

Hello,

we're not able to use docker hub while using access tokens. Is not fault of this action as it's not supported by docker hub.

ref:
docker/hub-feedback#1914

Would be nice if you could add a note about this to the readme.

Nice action idea otherwise.

kj.

I am trying to setup GitHub Actions to update my Dockerhub's Repo Description.

So far, my GitHub Actions can log in and update the image without issue (I use "docker/build-push-action@v3" to update my Docker Image). But I cannot update the image description

See one of my actions: https://github.com/y0utubeperson1/test-dock1/runs/7591832228?check_suite_focus=true#step:13:13

This is my Actions YAML file: https://github.com/y0utubeperson1/test-dock1/blob/main/.github/workflows/test_dockerfile.yml

My Image on Docker Hub: https://hub.docker.com/repository/docker/y0utubesir/mytestimg

I am using Docker Tokens.

How come I can successfully update my image but not description?

It would be nice if it check for a readme file in the root directory of different casings instead of just failing if the casing is any different.

Hello Peter,

I have been using your GitHub Action with success in the past; but somehow it broke down (or I broke it 😉). I have a 2FA enabled Docker Hub account and have set DOCKERHUB_PASSWORD secret in GitHub with my account password (not the personal access token, as instructed in your README.md).

The response I am receiving:

Acquiring token
Sending PATCH request
Received response code: 401
##[error]Docker run failed with exit code 1

Link to a successful run 6 weeks ago: action
Link to an unsuccessful run today: action

Could you help me resolve the issue? I suspect there is something wrong in the API communication since I haven't made any changes to the Github Action .yml file.

It's difficult to find this source code repository if you only know the Docker Hub location of the created image.

Could you add a link back to the source code repository, and maybe make the link to the LICENSE file an absolute URL?

Hi! Thanks for this very good Action.

I'm trying to set it up in one of our repositories, but it doesn't seem to work quite right:

Run peter-evans/[email protected]
  env:
    DOCKERHUB_USERNAME: ***
    DOCKERHUB_PASSWORD: ***
    DOCKERHUB_REPOSITORY: switchbladebot/invidget
/usr/bin/docker run --name peterevansdockerhubdescription230_2c9e6b --label 8118cb --workdir /github/workspace --rm -e DOCKERHUB_USERNAME -e DOCKERHUB_PASSWORD -e DOCKERHUB_REPOSITORY -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/invidget/invidget":"/github/workspace" peterevans/dockerhub-description:2.3.0
/entrypoint.sh: line 29: can't open ./README.md: no such file
Acquiring token
sh: 25000: unknown operand
Sending PATCH request
Received response code: 200
Request successful

It can't find the README file (because I didn't run the checkout action), but it still succeeds because the response from Docker Hub was a 200.

Good work, I've been using this Docker App since months and today I realize the action failed with 400

Run peter-evans/[email protected]
/usr/bin/docker run --name peterevansdockerhubdescription210_d5aa4c --label 8118cb --workdir /github/workspace --rm -e DOCKERHUB_USERNAME -e DOCKERHUB_PASSWORD -e DOCKERHUB_REPOSITORY -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/jina/jina":"/github/workspace" peterevans/dockerhub-description:2.1.0
Acquiring token
Sending PATCH request
Received response code: 400

GitHub has started issuing this warning

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: peter-evans/dockerhub-description@v2. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

I got "ENOENT: no such file or directory, open './README.md'"

My Repo: https://github.com/b-reich/latex-docker

Hello,

i tried using this with the recently introduced DockerHub access tokens, but it doesn't work. I swapped my credentials for my own Docker Hub and it works again.

If i check the Docker Hub access tokens page, i see that the access token was never used.

When using the access token i get an error 403 on the PATCH request.

Nice piece of work, thank you for making this.

I get how this updated the readme on docker hub, that worked perfectly once I worked out I couldn't use the API token.
I am missing how this updates the docker hub description? Aka this:

Hello, thanks for the nice tool first 👍

However, on my repository, using this workflow file, I keep on receiving the error:

Run peter-evans/[email protected]
/usr/bin/docker run --name peterevansdockerhubdescription210_fa0d35 --label e87b52 --workdir /github/workspace --rm -e DOCKERHUB_USERNAME -e DOCKERHUB_PASSWORD -e DOCKERHUB_REPOSITORY -e HOME -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/private-internet-access-docker/private-internet-access-docker":"/github/workspace" peterevans/dockerhub-description:2.1.0
Acquiring token
Sending PATCH request
Received response code: 400

Any idea on how to fix it?

Thanks!

I have recently integrated this GitHub action into the fedimint-ui repository. I am using this action in this workflow. The workflow is failing with the ENOENT: no such file or directory, open './apps/gateway-ui/README.md' error even though the same file clearly exists in the repository. Can please someone help me debugging the same?

This is part of gitlab-ci.yml, and gitlab-runner locally on osx

script:
 - docker tag $NAME ${CI_REGISTRY}/${CI_PROJECT_PATH}:$TAG
 - docker push ${CI_REGISTRY}/${CI_PROJECT_PATH}:$TAG
   

 - >-
     docker run -v $PWD:/workspace \
      -e DOCKERHUB_USERNAME="$DOCKERHUB_REGISTRY_USER" \
      -e DOCKERHUB_PASSWORD="$DOCKERHUB_REGISTRY_PASSWORD" \
      -e DOCKERHUB_REPOSITORY="${DOCKERHUB_REGISTRY}/${CI_PROJECT_PATH}" \
      -e README_FILEPATH='/workspace/README.md' \
      peterevans/dockerhub-description:2

      
ERROR: Job failed: exit status 1
FATAL: exit status 1   

I've started using your action in my workflow:
https://github.com/akloeckner/TileBoard-docker-nightly/actions/runs/805068712

Thanks a lot!

I trigger the workflow on a schedule and use nothing special in it as far as I can see:

    - name: Check out code
      uses: actions/checkout@v2
    - name: Update Docker Hub description
      uses: peter-evans/dockerhub-description@v2
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: akloeckner/tileboard
        short-description: ${{ github.event.repository.description }}

It gives me the following error message:

Run peter-evans/dockerhub-description@v2
  with:
    username: ***
    password: ***
    repository: ***/tileboard
    short-description: Nightly builds of Tileboard
Acquiring token
Warning: Can't add secret mask for empty string in ##[add-mask] command.
Sending PATCH request
Error: Unauthorized

The error is not reproducible to me, since it sometimes runs through and sometimes gives the error above. If I then "re-run all jobs", it works as expected. Also, when I start the workflow manually, I has worked all the time so far.

Do you have any idea, what could cause this?

When using a organization repository on docker-hub, and using a helper-user to push, this helper-user needs admin-rights (not read&write).

This should be mentioned in the documentation - took me a bit to figure out.

Not sure if you can fix this one, but when the character < is found in the README.md the upload stops at that character. No errors are returned (just 200 OK), but the chracter < and everything afterwards is missing.

Sample that breaks the upload: https://github.com/hotio/docker-radarr/tree/d2b7b5544a06d70bbe0235ef6a09b8377e1fa26e#execute-scripts-at-startup

Hi,
My action fails with
ENOENT: no such file or directory, open './README.md'
Although the file exists.
Repo: https://github.com/tzurielweisberg/testing-docker-description

Job: https://github.com/tzurielweisberg/testing-docker-description/actions/runs/6008305397/job/16295739517

Action:

name: Send description

on:
  workflow_dispatch:

jobs:
  build:
    name: Send description
    runs-on: ubuntu-latest
    steps:
    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v3
      with:
        username: ${{ secrets.DOCKER_USER }}
        password: ${{ secrets.DOCKER_PWD }}
        repository: ${{ secrets.DOCKER_REPO_NAME }}

hey @peter-evans, thanks for this project! This might sound like a stupid question, but is this action still working for you? When I try to run the PATCH request from your script (with something like:)...

echo test > README.md
TOKEN=$(curl -s -H "Content-Type: application/json" -X POST -d '{"username": "'myuser'", "password": "'mypassword'"}' https://hub.docker.com/v2/users/login/ | jq -r .token)
curl -v -L -s -H "Authorization: JWT ${TOKEN}" -X PATCH --data-urlencode full_description@./README.md https://hub.docker.com/v2/repositories/myuser/hello-world

...then I'm getting a HTTP/200 return code but the full-description field remains unchanged. My token is definitely fine, I can successfully delete my repo with it (with a DELETE request).

(If it still works for you then I must be making some stupid mistake. But I suspect the (undocumented) dockerhub api has changed and its generally broken?).

thanks in advance for your feedback!

Version tags are not correctly pushed to docker hub. The reason is that the GitHub workflow uses only docker push [IMAGE] and thus pushes just the default tag, ie latest.

I ran a few hundred workflows that all showed successful but did in fact not update the description.

See screenshot or in the result

Am I doing something wrong?

Currently I have no way of knowing as the response is not being captured and the success message is always showing regardless of the response.

Hello,
I would like to requests an inclusion of needed permission in README file.

As user fauust pointed out in issue #10 access tokens must have read/write/delete access level in order to work. This took me quite a while to pinpoint. Neither this project's documentation or docker settings do a good job of pointing that out. It would be great if that was explained in readme.

As a user X, I can have push access to repository Y/Z on Docker Hub.

Currently it's impossible to interact with it.

Please change behaviour of DOCKERHUB_REPOSITORY to accept <namespace>/<name> format, so that doing the following is possible:

    - name: Docker Hub Description
      uses: peter-evans/[email protected]
      env:
        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
        DOCKERHUB_REPOSITORY: ${GITHUB_REPOSITORY,,}

Thank you :).

Thanks for this action. I am unable to get it to work this. I am pretty sure it's something I am doing wrong. I am getting the following error:

Run peter-evans/[email protected]
/usr/bin/docker run --name peterevansdockerhubdescription210_916cb2 --label 671ee6 --workdir /github/workspace --rm -e DOCKERHUB_USERNAME -e DOCKERHUB_PASSWORD -e DOCKERHUB_REPOSITORY -e HOME -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e GITHUB_ACTIONS=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/bandersnatch/bandersnatch":"/github/workspace" peterevans/dockerhub-description:2.1.0
Acquiring token
Sending PATCH request
Received response code: 403
##[error]Docker run failed with exit code 1

• I tried @master + @v2.1.0

Full Action: https://github.com/pypa/bandersnatch/commit/a74735341fad9e17e45e5fddf24b4c893aac2740/checks?check_suite_id=380791017

Is this just credential and potential access to pypa/bandersnatch readme update?
(Have asked the owner of the org to check my access)

As you can see here https://github.com/acouvreur/sablier/actions/runs/4646770934/jobs/8223387131

Reading description source file
Warning: The short description exceeds DockerHub's limit and has been truncated to 100 bytes.
Acquiring token
Sending PATCH request
Error: Bad Request

I did re-run it with debug logging for the following job:
https://github.com/acouvreur/sablier/actions/runs/4646770934/jobs/8232625295

And you can see this:

##[debug]Error: Bad Request
##[debug] at /home/runner/work/_actions/peter-evans/dockerhub-description/v3/dist/index.js:82:23
##[debug] at processTicksAndRejections (node:internal/process/task_queues:96:5)

Do you have any idea why it doesn't work as it used to work before?

There seems to be some breaking changes to update to v3. There is an upgrade guide here.

Dependabot cannot auto-bump: #84

If you would like to help with this issue please make the minimum changes necessary to upgrade.

In the action you allow for short-description to be passed.

Could you allow this option to be set to true which would then take the GitHub Repro Description and sync that to the Docker Hub Description?

Hello @peter-evans
Ive tried your github action and before my readme.md was just to big with 37KB. I was basically successfully getting the 25.000 byte error and it didnt do anyting.

No i have reduced my readme.md considerable, now im getting the "Error: Forbidden" error.

What i tried:

• Comment out enable-url-completion: true
• Added new key, with still read/write/delete rights
• Checked existing for read/write/delete
• re-run the job after like 15m

Im not sure on how to fix this, please help me.

My pipeline-line: https://github.dev/jammsen/docker-palworld-dedicated-server/blob/master/.github/workflows/docker-build-and-push-prod.yml

Error-Screenshot:

Thank you very much for writing this tool, but when I was using it I encountered some problems:

I am not sure where the problem is coming from, so I created this issue. here is the code for my action:

name: Publish Docker image

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:
  push_to_registry:
    name: Push Docker image to Docker Hub
    runs-on: ubuntu-latest
    steps:
      - name: Check out the repo
        uses: actions/checkout@v3
      
      - name: Log in to Docker Hub
        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
      
      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
        with:
          images: randark/nssctf-round_v7-shadowflag
      
      - name: Build and push Docker image
        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
        with:
          context: .
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
      - name: Docker Hub Description
        uses: peter-evans/dockerhub-description@v3
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}
          repository: RandarkJMT/NSSCTF-Round_v7-ShadowFlag

Hello,

Thanks for this great project.

We are using it in our CI, and since July 14th, we have seen it failing with response 415.

Run peter-evans/[email protected]
  env:
    DOCKERHUB_USERNAME: ***
    DOCKERHUB_PASSWORD: ***
    DOCKERHUB_REPOSITORY: jinaai/jina
    readme-filepath: ./README-trunc.md
/usr/bin/docker run --name peterevansdockerhubdescription[2](https://github.com/jina-ai/jina/runs/7342353736?check_suite_focus=true#step:6:2)[3](https://github.com/jina-ai/jina/runs/7342353736?check_suite_focus=true#step:6:3)0_5d[4](https://github.com/jina-ai/jina/runs/7342353736?check_suite_focus=true#step:6:4)cfa --label 4cd98f --workdir /github/workspace --rm -e DOCKERHUB_USERNAME -e DOCKERHUB_PASSWORD -e DOCKERHUB_REPOSITORY -e readme-filepath -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e GITHUB_STEP_SUMMARY -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/jina/jina":"/github/workspace" peterevans/dockerhub-description:2.3.0
Acquiring token
Sending PATCH request
Received response code: 41[5](https://github.com/jina-ai/jina/runs/7342353736?check_suite_focus=true#step:6:5)
Request failed

You can find a link to the failed action run here:

https://github.com/jina-ai/jina/runs/7342353736?check_suite_focus=true 

Is there something that has changed in the last days that could be causing this?

Thank you very much

I just stumbled across a weird issue, where the action would suddenly fail (after quite a while not being executed at all).
After digging into the issue, it seems that the short-description limit is not correctly enforced.
The short-description input was introduced with 8fa8201, which already truncates inputs longer than 100 characters (since otherwise the API would return a status code 400 / Bad Request):

• 25 emojis, successful: https://github.com/alexrashed/dockerhub-description-unicode/actions/runs/4617334701/jobs/8163468328
• 100 ASCII characters, successful: https://github.com/alexrashed/dockerhub-description-unicode/actions/runs/4617378471/jobs/8163566247
• 26 emojis, 400 / Bad Request: https://github.com/alexrashed/dockerhub-description-unicode/actions/runs/4617345906

The run with 26 emojis results in the following error:

##[debug]Inputs: {
##[debug]  username: '***',
##[debug]  password: '***',
##[debug]  repository: '***/dockerhub-description-tests',
##[debug]  shortDescription: '💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻💻',
##[debug]  readmeFilepath: './README.md',
##[debug]  enableUrlCompletion: false,
##[debug]  imageExtensions: 'bmp,gif,jpg,jpeg,png,svg,webp'
##[debug]}
Reading description source file
##[debug]💻
Acquiring token
::add-mask::***
Sending PATCH request
##[debug]Error: Bad Request
##[debug]    at /home/runner/work/_actions/peter-evans/dockerhub-description/v3/dist/index.js:83:23
##[debug]    at processTicksAndRejections (node:internal/process/task_queues:96:5)
Error: Bad Request
##[debug]Node Action run completed with exit code 1
##[debug]Finishing: Docker Hub Description

This could be explained by UTF-8 being a variable-length content-encoding where code-points with lower numerical values are using fewer bytes. This would basically mean that the limit of 100 is actually a limit of 100 bytes, not 100 characters.

1. Thanks for this container!
2. Just a remark: you could catch the response code 200 & output something like 'upload succeeded'

Hello,

I have a README.md file of 39k and I can't upload it due to size limit. I'm using dockerhub-description action as follows:

      - name: Update Docker Hub description
        if: github.event_name != 'pull_request'
        uses: peter-evans/dockerhub-description@v3
        with:
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

Related run: https://github.com/orhun/git-cliff/runs/7540171483

Looks like the team made progress a few months ago to allow updating description using PAT: docker/hub-feedback#2127

I think this can now be used to update descriptions.

Hi! First of all, thanks for creating this extremely useful action.

I use it in many of my projects. Just want to make two suggestions:

• emojis are not rendered on Docker Hub. It would be nice to replace all emojis like :whale: with the equivalent UTF-8 🐳 before deploying the markdown file
• images with relative paths are not displayed correctly on Docker Hub. It would be nice to prepend https://raw.githubusercontent.com/<user_name>/<repo_name>/<branch_name>/ to all relative images paths before deploying the markdown file

See my desktainer repo and the related Docker Hub page for an example of what i mean.

I know that these problems are not this action's fault but Docker Hub's, so feel free to close this issue if you don't wanna do these.

Hey,

I am trying to set up this action in a demo repository, but the upload to dockerhub fails.

The GitHub repository: https://github.com/NotMyFault/dockerhub-sync-em
The dockerhub repository: https://hub.docker.com/r/notmyfault1/sync-demo
The error: https://github.com/NotMyFault/dockerhub-sync-em/actions/runs/5718510401/job/15494494754

##[debug]Truncated short description: 
Acquiring token
::add-mask::***
Sending PATCH request
##[debug]Error: Not Found
##[debug]    at /home/runner/work/_actions/peter-evans/dockerhub-description/v3/dist/index.js:82:23
##[debug]    at processTicksAndRejections (node:internal/process/task_queues:96:5)
Error: Not Found
##[debug]Node Action run completed with exit code 1
##[debug]Finishing: Update Docker Hub description

Currently, I'm authenticating with a username and password, am I missing something?

Thanks in advance!