Fix Docker image name and credential precedence in README#12
Merged
Conversation
The README told users to run `entropy-data/cli`, which is not published. The image built and pushed by .github/workflows/release.yaml is entropydata/entropy-data-cli.
simonharrer
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two README corrections found during a docs gap analysis. Companion doc fixes: entropy-data/entropy-data-docs#122 and entropy-data/entropy-data-docs#123.
Docker image name
The README tells users to run
entropy-data/cli, which is not a published image. The image built and pushed by.github/workflows/release.yaml:147isentropydata/entropy-data-cli.The invocation works as written once the name is right: the Dockerfile uses
ENTRYPOINT ["entropy-data"], so--helppasses through, anddocker/metadata-action's defaultlatest=autopublisheslatestalongside the semver tags on each release.Credential precedence
The README says:
That collapses two distinct layers.
resolve_connectioninconfig.pyapplies the connection named by--connectionbefore consulting environment variables, so an explicit--connectionoverrides them. Only the default connection from the config file sits below env vars. The API key and host are also resolved independently, so one can come from the environment and the other from a connection.