Dockerfile: improve and update to GHCR #245
Conversation
|
|
||
| ## Naming images | ||
|
|
||
| Image tags MUST be the same as the project name but with underscore (`_`) | ||
| Docker image tags MUST be the same as the project name but with underscore (`_`) | ||
| replaced with forward slash (`/`). |
There was a problem hiding this comment.
| replaced with forward slash (`/`). | |
| replaced with forward slash (`/`) and `ocr-d` spelled in lower case. |
There was a problem hiding this comment.
Is that the right context to prescribe ocr-d though? IIUC this spec applies to any external module, too. Within github.com/OCR-D we will use that prefix sure, but others should be free to do their thing (including Dockerhub or GHCR or some Gitlab or whatever registry), right?
There was a problem hiding this comment.
Sure, I only wanted to prevent people from running into the same problem with ocrd vs OCR-D vs ocr-d. In DockerHub I could add people to the team "ocrd", so they could publish their repos (which did not need to be in the OCR-D organization in GH) to docker.io/ocrd/calamari for example.
Since that does not work with ghcr.io AFAIK, we should maybe not restrict the naming of the image at all?
There was a problem hiding this comment.
The paragraph is not about the name of the registry though. It's merely prescribing to not use underscore (because that's forbidden, see docker-image-tag(1)). And since projects are not even required to have ocrd as a name prefix, it could be anything anyway. So for example, once the collegues from Qurator project start providing Docker images, they could place everything under qurator/... (which incidentally they already did btw). And I can use bertsky/... or slub/... etc. With GHCR, it becomes mandatory to use the GH org as prefix, so no need to say anything about that here, either.
There was a problem hiding this comment.
because that's forbidden, see
docker-image-tag(1)
Actually, it's not forbidden to use underscores in image tags, only in the host name part of the registry. (I did not catch this when I first read it, because the documentation is a bit cryptic.)
And because for external projects (outside of github.com/OCR-D), their connection to OCR-D is only expressed with the typical ocrd_ prefix, I would even say we should remove this formulation entirely, or at least soften it from a MUST to a SHOULD.
For example, it does not make sense to remove the ocrd_ from bertsky/ocrd_detectron2: bertsky/detectron2 would be confused with a variant of detectron2 proper, and bertsky/ocrd/detectron2 is not allowed.
(I am not saying we should completely reverse course and even use ocrd/ocrd_tesserocr, although I would not object to it. But mandating the removal of ocrd and underscores just does not make sense for external modules.)
No description provided.