[Feature]: Publish description and readme to Docker Hub

[yurishkuro]

Requirement

As a user downloading Jaeger images from Docker Hub, I want to be able to read a description and basic usage in the Docker Hub repositories.

Problem

Right now most of Jaeger's Docker Hub repositories contain neither description nor the readme.

Proposal

Use Docker Hub API to push the README files from the respective cmd/*** dirs when publishing Docker images.

Example: https://github.com/peter-evans/dockerhub-description/blob/main/src/dockerhub-helper.ts

Open questions

No response

[YashasviChaurasia]

@yurishkuro i would like to work on this issue.

[yurishkuro]

Great, go for it. Don't worry about the descriptions themselves, we first want to set up the process, and then we can improve the readmes.

[YashasviChaurasia]

@yurishkuro

I have Tested the Workflow and have tested it on my personal repository to upload Readme files on two different docker-hub repos namely "yashasvichaurasia/testing" and "yashasvichaurasia/testlife"

Following are some screenshots:

[YashasviChaurasia]

@yurishkuro
I have written the jobs in '.yml' in the following template where I have assumed the admin username and password to be in the following repository secrets as we would require admin privileges while accessing docker hub while using this workflow:

    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v3
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description
        readme-filepath: ./path/to/README.md

In one .yml file, I have created multiple jobs which will upload Readme's to different docker-hub repositories when a push is triggered on the Github repo.

Kindly evaluate my way of thinking and let me know if I should create a PR if it is correct.
Thank you

[yurishkuro]

We don't want to pass Dockerhub credentials to unofficial / 3rd-party GH actions like peter-evans/dockerhub-description@v3. It would be better to have the code directly in Jaeger repo. Also, we run a script to build & publish many different images, I think it would make more sense to upload READMEs as part of that script rather than manually list each image in the GH action.

[YashasviChaurasia]

Ok, I will get on to work on that.
Thank you

[YashasviChaurasia]

@yurishkuro could you help me out on how to proceed , I am feeling a bit stuck with the Dockerhub API.
Thank you

[yurishkuro]

I haven't investigated it, but the link I have in the description shows code example of submitting via the api. I assume we can do it similarly with just a curl command that we can include in one of the scripts.

[h20220025]

hey @yurishkuro this issue seems interesting and i want to work on this issue so could you allow me to work on the same:)

[yurishkuro]

@h20220025 you don't need to ask permission, go for it.

[h20220025]

could you please assign this to me ???

[h20220025]

Thank You @yurishkuro

[h20220025]

hey @YashasviChaurasia, are you still working on the same ???
if yes please let me know.

[YashasviChaurasia]

hey @YashasviChaurasia, are you still working on the same ???
if yes please let me know.

yes, I am working on this but you can submit a PR if you are able to solve the issue.

[Pushkarm029]

@SaarthakMaini are you still working on this?

[yurishkuro]

This is still up for grabs, and a very useful feature to solve.

[varshith257]

@yurishkuro I am ready to grab it.

[yurishkuro]

Feel free. I recommend reviewing comments on the previous PR to avoid repeating the same things.

[yurishkuro]

@inosmeet the PR didn't work once merged:

2024-10-26T01:38:52.0430636Z 🛑 Failed to update Docker Hub README for jaegertracing/jaeger-tracegen with status code 401
2024-10-26T01:38:52.0432014Z Full response: {"message":"unauthorized","errinfo":{}}
2024-10-26T01:38:52.0432550Z
2024-10-26T01:38:52.1479920Z Failed to update Quay.io README for jaegertracing/jaeger-tracegen with status code 403
2024-10-26T01:38:52.1480759Z Full response: {"error": "CSRF token was invalid or missing."}

when you were testing it did you define special permissions for the token?

[inosmeet]

Just Read & Write.

[yurishkuro]

@inosmeet it's not working for me. I was actually able to get the script to succeed after I did a docker login locally, but if I am not logged it, the curl commands fail on authorization.

Can you point to the documentation that describes the corresponding REST APIs?

[inosmeet]

@yurishkuro The API endpoint we're using is undocumented. I got the reference from here

[yurishkuro]

@inosmeet how did you generate the tokens you used? I only have PAT available to the workflow, but the issue you linked mentioned "properly scoped JWT generated from a PAT". Same question for quay.

[inosmeet]

@yurishkuro I used DockerHub website to create PAT manually. And it gives a scoped JWT for authentication. Same for quay, we can generate token manually from the website.

[yurishkuro]

It looks like it started working for Docker (I had to give Delete permission to the token, not just read/write), but it's still not working for Quay, even if I give the user Admin role. Maybe because we're using a robot account for Quay.