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

Allow developers to specify Docker image tags; reference them in Compose file #648

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

matthew-li
Copy link
Collaborator

Description

**** Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. ****

  • Updated the Docker images to allow the user to specify a tag (defaulting to latest).
  • Updated the script for building the images to optionally take a tag as input.
  • Updated the Docker Compose file to reference specific tags:
    • If the IMAGE_TAG environment variable is set, images with that tag are used.
    • Otherwise, the latest images are used.
  • Discussed these options in the Docker README.md.

This enables a developer to build a separate set of images (e.g., when testing a different branch) without overriding their existing images.

Type of change

**** Please delete options that are not relevant. ****

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

**** Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. ****

  • Review the changes to README.md.
  • Run build_images.sh both with and without an optional argument. Ensure that images are built and tagged successfully.
  • Bring up the Docker Compose stack both with and without specifying an IMAGE_TAG environment variable. Ensure that the correct images are used.

PR Self Evaluation

Strikethrough things that don’t make sense for your PR.

  • My code follows the agreed upon best practices
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if needed)
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in the appropriate modules
  • I have performed a self-review of my own code

@matthew-li matthew-li requested a review from Hzaakk October 14, 2024 19:37
@matthew-li matthew-li changed the title Allow user to specify Docker image tags; reference them in Compose file Allow developers to specify Docker image tags; reference them in Compose file Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant