Document ability to cancel a push
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
When I try to push an image without having logged into the registry, it takes a long while to timeout and even retries multiple times. The Docker API specifies that closing the connection will cancel the upload.
This actually works by doing cli.close() because it inherits from requests, but it would be nice if this was documented or supported.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Docker API behavior described in the issue and the client interface around cli.close(), then check how push operations are documented. Done means the supported way to cancel an image upload is clearly documented, including the unauthenticated-registry timeout case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100