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

resolves #698 update the description on Docker Hub #737

Merged
merged 17 commits into from
May 16, 2021
Merged

resolves #698 update the description on Docker Hub #737

merged 17 commits into from
May 16, 2021

Conversation

lind
Copy link
Contributor

@lind lind commented May 9, 2021

A proposal for #698

I'm new to GitHub Actions but the action mentioned in the #698 should work. But I don't know if there is a way to test this without actually change the description in Dockerhub.

I''m not sure the README is the right file to use as the Dockerhub description since the README includes build information etc. not relevant to Dockerhub users and also there are a need for multiple Dockerhub descriptions, one for each docker image; bmpn, excalidraw...

Proposes one description file for each image in the same dir as the Dockerfile /bpmn, /excalidraw...

The proposed DOCKERHUB.md is just a copy and slight simplification of the description on Dockerhub today and needs some more work.

What do you think @Mogztter

DOCKERHUB.md Outdated Show resolved Hide resolved
DOCKERHUB.md Outdated Show resolved Hide resolved
DOCKERHUB.md Outdated Show resolved Hide resolved
DOCKERHUB.md Outdated Show resolved Hide resolved
DOCKERHUB.md Outdated Show resolved Hide resolved
DOCKERHUB.md Outdated Show resolved Hide resolved
@ggrossetie
Copy link
Member

Thanks @lind!

I'm new to GitHub Actions but the action mentioned in the #698 should work. But I don't know if there is a way to test this without actually change the description in Dockerhub.

I don't think so but it's not a big deal since I can easily restore the description if something goes wrong.

I''m not sure the README is the right file to use as the Dockerhub description since the README includes build information etc. not relevant to Dockerhub users and also there are a need for multiple Dockerhub descriptions, one for each docker image; bmpn, excalidraw...

You are 💯 right, we should use a dedicated file.

Proposes one description file for each image in the same dir as the Dockerfile /bpmn, /excalidraw...

I agree but let's do that in a follow-up pull request.

The proposed DOCKERHUB.md is just a copy and slight simplification of the description on Dockerhub today and needs some more work.

I left a few suggestions but overall 👍🏻

What do you think @Mogztter

It looks very good, thanks for taking care of this.

@lind
Copy link
Contributor Author

lind commented May 15, 2021

Proposes one description file for each image in the same dir as the Dockerfile /bpmn, /excalidraw...

I agree but let's do that in a follow-up pull request.

Good idea. Let's get this to work for the main docker hub repository first.

lind and others added 7 commits May 15, 2021 15:27
Co-authored-by: Guillaume Grossetie <[email protected]>
Co-authored-by: Guillaume Grossetie <[email protected]>
Co-authored-by: Guillaume Grossetie <[email protected]>
Co-authored-by: Guillaume Grossetie <[email protected]>
Co-authored-by: Guillaume Grossetie <[email protected]>
DOCKERHUB.md Show resolved Hide resolved
@ggrossetie ggrossetie changed the title Proposal action for Dockerhub description resolves #698 update the description on Docker Hub May 16, 2021
@ggrossetie ggrossetie merged commit 725ad84 into yuzutech:main May 16, 2021
@ggrossetie
Copy link
Member

Thanks @lind, it's working great 🎉
The description is now up-to-date: https://github.com/yuzutech/kroki/actions/workflows/dockerhub-description.yml

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

Successfully merging this pull request may close these issues.

2 participants