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

docker/release: Add README updates #25786

Merged
merged 1 commit into from
Mar 15, 2023
Merged

Conversation

phlax
Copy link
Member

@phlax phlax commented Feb 26, 2023

Fix #19784

This PR provides automated updates to the dockerhub Envoy repo (https://hub.docker.com/r/envoyproxy/envoy)

The strategy is that the readme/description is updated on every push to main, using (changelog/version) info that is current

There are a couple of implications:

  • releases will not update until a subsequent change to main has landed
  • main want to keep its changelog/branches up-to-date

these points are not so important in this PR but potentially will be if we add more info in the page - eg the actual version v1.23.4 in addition to just the latest

the benefit of doing it this way is that it is much simpler as only main has current info and only one branch is responsible for doing these updates

Commit Message:
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

@phlax phlax marked this pull request as draft February 26, 2023 11:19
@phlax phlax force-pushed the docker-patch-readme branch 6 times, most recently from e8631d8 to 972bdac Compare March 1, 2023 08:51
@phlax
Copy link
Member Author

phlax commented Mar 1, 2023

test output is here https://hub.docker.com/r/gpt4/envoy

displayName: "Publish Dockerhub description and README"
env:
DOCKERHUB_USERNAME: $(DockerUsername)
DOCKERHUB_PASSWORD: $(DockerPassword)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lizan for this to work the PAT has to have admin permissions

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checking the existing creds and it doesnt have this it will need to be updated before this can land

its unfortunate that the dockerhub API require so much permission to update the description

according to this comment docker/hub-feedback#2127 (comment) the current permissions should be sufficient now

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

testing this further and to use a PAT it must have the read/write/delete permissions

@phlax phlax force-pushed the docker-patch-readme branch 4 times, most recently from 9a0f402 to a64ca83 Compare March 1, 2023 10:30
@phlax
Copy link
Member Author

phlax commented Mar 1, 2023

This just adds a template-built README and publishes it from main to the envoyproxy/envoy dockerhub repo

There are a few follow ups i will do

For the legacy repos - eg envoyproxy/envoy-dev etc - we can put a page saying use the newer tagged images and link to the page included here

I would also like to add some precheck CI to ensure readmes can be built successfully from templates and potentially publish them to GCS so they can be visually checked during review

the README itself is ~based on the READMEs that official projects have - there are some more sections to add - eg usage

@phlax phlax changed the title [WIP] docker/release: Add README updates docker/release: Add README updates Mar 1, 2023
@phlax phlax marked this pull request as ready for review March 1, 2023 10:48
@phlax
Copy link
Member Author

phlax commented Mar 3, 2023

contrib is missing - ill add ...

done

@phlax phlax marked this pull request as draft March 3, 2023 13:09
@phlax phlax changed the title docker/release: Add README updates [WIP] docker/release: Add README updates Mar 3, 2023
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the docker-patch-readme branch from a64ca83 to 1cfed8f Compare March 6, 2023 08:17
@phlax phlax changed the title [WIP] docker/release: Add README updates docker/release: Add README updates Mar 6, 2023
@phlax phlax marked this pull request as ready for review March 6, 2023 08:18
@phlax
Copy link
Member Author

phlax commented Mar 6, 2023

flagging that this requires a creds change before it can land

@phlax phlax merged commit fd2dc3d into envoyproxy:main Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Dockerhub metadata (page)
3 participants