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

Add a docker-compose.yml file for development purposes #3

Merged
merged 3 commits into from
Sep 23, 2021

Conversation

alexandre-abrioux
Copy link
Contributor

@alexandre-abrioux alexandre-abrioux commented Aug 8, 2021

Hi!

I though that it could be convenient to allow contributors the option to work with a docker-compose.yml file. Doing so ensures the developer works with the same node version as the one used in production.

No more yarn needed on the developer machine, just docker exec -ti noether sh to get a shell access and easily run tests, etc...

I also updated the .dockerignore file to ignore the docker-compose.yml that will not be needed in the Docker image, as well as other files and dirs that could also be added.

Regarding the compose file, we could also name it docker-compose.dev.yml or docker-compose-dev.yml if you think the current name could lead to confusion for standard users, but it would mean a more verbose command to bootstrap the contributor environment:
docker-compose -f docker-compose.dev.yml up -d instead of the simple docker-compose up -d.

Please tell me if you have any question or you would like to see more improvement to the work I've done. Thanks!

@cf-cartesi
Copy link

cf-cartesi commented Aug 12, 2021

Looks good. Personally I'd prefer forcing a more verbose invocation by adding -dev or something alike to the docker compose file name, but the default name works too.

@alexandre-abrioux
Copy link
Contributor Author

Added the suffix :)

@tuler tuler merged commit 75ae0ee into cartesi:develop Sep 23, 2021
@alexandre-abrioux alexandre-abrioux deleted the docker-compose branch September 23, 2021 08:21
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.

None yet

3 participants