search

christian-korneck / docker-pushrm

"Docker Push Readme" - a Docker CLI plugin to update container repo docs
MIT License
139 stars 4 forks source link

Max characters allowed in README.md? #28

Closed stacyhung closed 1 year ago

stacyhung commented 1 year ago

I was trying to push a README to my docker repository with:

docker pushrm {user}/{repo}

the --debug version of the run produced the error message:

DEBU push readme, response body: {"message":"httperror 400: request had 1 validation error","errinfo":{"fielderrors":{"full_description":"Exceeded max number of characters"}}}

I'm using version 1.9.0 of the docker CLI plugin with docker 23.0.5, build bc4487a.

My README.md is quite long, so I'm wondering what is the maximum number of characters allowed?

christian-korneck commented 1 year ago

@stacyhung I believe Docker Hub's current maximum length for the repo description is exactly 25000 characters. If you have a very long README I'd recommend splitting it in multiple Markdown files and linking them with each other.

(As this is a limitation of Docker Hub and not the docker-pushrm tool, there's little we can do about it, unfortunately).

stacyhung commented 1 year ago

Thanks for the quick response! Good to know.