Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme on docker hub #169

Open
straight-shoota opened this issue Nov 16, 2021 · 4 comments
Open

Update readme on docker hub #169

straight-shoota opened this issue Nov 16, 2021 · 4 comments
Labels

Comments

@straight-shoota
Copy link
Member

The readme at https://hub.docker.com/r/crystallang/crystal is outdated.

crystal-lang/crystal-dist#14 suggested an automation to update the readme from the Crystal repository. We could to this and integrate it as a step in docker/apply-latest-tags.sh.

However, I think it would be better to provide a readme specific to the docker repository, which explains the available image types. We might still want to have that automated to always show the latest tags, though.

@bcardiff
Copy link
Member

I would rather focus on publishing a Docker official image and mimic whatever the other languages are doing. See https://github.com/docker-library.

Eventually we could leave crystallang/crystal for CI and maybe nightlies.

@straight-shoota
Copy link
Member Author

Yes, that's already tracked in #126.

That doesn't mean we shouldn't have to update the readme, though.

@stellarpower
Copy link

Please could you add a comment as to the difference between the -dev and normal tags as part of this? Without diving into the filesystem or build scripts, it's not clear to me what the difference between the two is. FWIW, a number of projects copy across their readmes from source hosting to their docker hub pages, but personally I find it much more useful when the docker (or other image) pages describe specifically what happens as part of the image as opposed to a general overview of the project, so I think whatever happens re the above, adding more on this would be really helpful.

Cheers

@straight-shoota
Copy link
Member Author

straight-shoota commented May 24, 2023

The Docker hub has been manually updated to include information about tag naming schemes.

Automatically updated information about available tags (via crystal-lang/crystal-dist#14) would be a nice enhancement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants