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

Update README.md to account for new Docker tagging system #675

Merged
merged 6 commits into from
Aug 26, 2022

Conversation

alex-l-kong
Copy link
Contributor

What is the purpose of this PR?

Although start_docker.sh will no longer require explicit updates to ensure the right image gets pulled, the user still needs to ensure the correct image gets pulled.

start_docker.sh does automatically pull the image for you, but this only applies if you don't have the image already. If you need to overwrite an existing image, you'll need to explicitly run the docker pull command with the correct tag.

How did you implement your changes

Change the Docker section of the README.md to explicitly tell the user which tag to look out for when running the docker pull command. This change will also be applied to the Docker update section.

Remaining issues

If we plan on overwriting the Docker images each time the dependencies change, then we can just allow start_docker.sh to update the image in the background without explicit input from the user.

@srivarra srivarra mentioned this pull request Aug 25, 2022
5 tasks
@alex-l-kong
Copy link
Contributor Author

Since we'll be creating new Docker images each time it needs to be rebuilt (and never overwriting tags), we can just eliminate any need for the user to run docker pull (removing it from the README.md entirely), which simplifies the pipeline.

@ngreenwald ngreenwald merged commit e452c77 into main Aug 26, 2022
@ngreenwald ngreenwald deleted the docker_tag_sec branch August 26, 2022 20:51
@srivarra srivarra added the documentation Adding documentation to areas of the codebase. label Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Adding documentation to areas of the codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants