-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Conversation
e8631d8
to
972bdac
Compare
test output is here https://hub.docker.com/r/gpt4/envoy |
displayName: "Publish Dockerhub description and README" | ||
env: | ||
DOCKERHUB_USERNAME: $(DockerUsername) | ||
DOCKERHUB_PASSWORD: $(DockerPassword) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
9a0f402
to
a64ca83
Compare
This just adds a template-built README and publishes it from There are a few follow ups i will do For the legacy repos - eg 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 |
done |
Signed-off-by: Ryan Northey <ryan@synca.io>
a64ca83
to
1cfed8f
Compare
flagging that this requires a creds change before it can land |
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 currentThere are a couple of implications:
main
has landedmain
want to keep its changelog/branches up-to-datethese 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 latestthe 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 updatesCommit 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:]