8000 [docs] improve documentation for building images by swyxio · Pull Request #2557 · temporalio/temporal · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[docs] improve documentation for building images #2557

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

Merged
merged 4 commits into from
Feb 28, 2022
Merged

Conversation

swyxio
Copy link
Contributor
@swyxio swyxio commented Feb 28, 2022

What changed?

improve documentation for building images

Why?

when i was working on auto-setup, it was not obvious from the readme that the main way to build the image was to run make at the project root, until Alex told me.

How did you test it?

Potential risks

Is hotfix candidate?

@swyxio swyxio requested a review from a team as a code owner February 28 8000 , 2022 04:31
docker/README.md Outdated

To run docker image with dependencies:
* [docker-compose](https://docs.docker.com/compose/install/)
To *run* the docker image with dependencies (e.g. PostgreSQL and Elasticsearch), you can use `docker-compose`. See our [docker-compose repo](https://github.com/temporalio/docker-compose) for reference configurations.
Copy link
Contributor
@jbreiding jbreiding Feb 28, 2022

Choose a reason for hiding this comment

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

There is still a missing piece to use the locally built images.

The tags in the docker compose need to be updated to test

Assuming that is the goal of the update, build locally and make use of those built images.

DOCKER_IMAGE_TAG ?= test

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nice catch thank you, edited

Copy link
Contributor

Choose a reason for hiding this comment

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

On this topic, I think its time to add a .env file to the docker-compose repo.

It would be simpler to override the tag and for version updates as well.

swyxio and others added 2 commits March 1, 2022 01:37
Co-authored-by: Jeremy Breiding <jbreiding@users.noreply.github.com>
Co-authored-by: Jeremy Breiding <jbreiding@users.noreply.github.com>
Copy link
Contributor
@jbreiding jbreiding left a comment

Choose a reason for hiding this comment

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

LGTM

@swyxio swyxio merged commit b431869 into master Feb 28, 2022
@swyxio swyxio deleted the sw-yx-patch-1 branch February 28, 2022 19:51
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.

2 participants
0