Update Docker Compose Dev With New Features

[akibrhast]

Dependency

A person who has risen to the merge team and who is experiencing docker reloading the entire code base on every change and who wants to take this issue on. see notes

Overview

We need to update our docker-compose file such that it is dynamic and based off off .env file settings.

Action Items

• Docker Compose Should have the following variables coming from an .env file such that they are configurable.

  • The image key
  • The output ports value

• The docker compose should also go through some additional pre-build steps before it runs jekyll serve. These pre build steps should be configured in such a way that it is possible to turn on/off an individual pre-build step. At the moment, these steps includes:

  • Running an scss linter
  • Running an ES linter
  • Implement SCSS lint #1441
  • GitHub Actions: Implement ESlint #1442

• For merge team: Once the PR related to this issue is merged and this issue is closed, please edit section 1.6.a in the contributing.md file accordingly.

Resources/Instructions

More details available in issue ##1273

[ExperimentsInHonesty]

I think this issue will never get worked on if it sits in the icebox but no one knows about it. Can we add something to the CONTRIBUTING.md so that if anyone has a problem with it AND they rise to the level of merge team, they can take on this issue.

[juliansmith0]

per 1.6.a in CONTRIBUTING.md: "NOTE: If it takes longer than 2 minutes to build your website using docker-compose up, please let the technical leads know about this and add your website build time in a comment to #1443. Also, once you are part of the merge team, you can work on #1443 and fix it (if you want)."

running docker-compose up successfully for the first time did indeed take longer than 2 minutes for me. Total, it took 16.5 minutes. Here's the full output with regards to time taken:

⠿ hfla_site Pulled 440.3s
⠿ cbdbe7a5bc2a Pull complete 1.2s
⠿ aa8ae8202b42 Pull complete 1.3s
⠿ b21786fe7c0d Pull complete 1.3s
⠿ 68296e6645b2 Pull complete 53.6s
⠿ 6b1c37303e2d Pull complete 53.6s
⠿ d603698ce36b Pull complete 438.1s
[+] Running 1/1
⠿ Container hfla_site Recreated 0.7s

[SAUMILDHANKAR]

@juliansmith0 Thanks for adding your comment regarding the time taken to run docker-compose up for the first time. Just wanted to check if the long time taken was only for the first time or if the time improved considerably during your subsequent attempts to run docker-compose up. Please let us know. Thanks again for sharing.

[fyliu]

I'm working with a docker setup recently and just want to leave a comment while I have things fresh in my mind.

Resource

• Docker docs has a section on using env vars in compose files

Comments on the pre-build steps

• I know it might be obvious, but they could go into the command value in the compose file. They can be set to conditionals depending on env variables. This way, they will run before jekyll serve like the action item wants.
• It might be better to have a separate script to run those pre-build steps since I assume the docker-compose process stays running at the jekyll server .... --livereload ... command. One would have to stop and rerun the container to run the pre-build steps again with this setup. This is why I'm suggesting running them separately so that the jekyll server can stay running.
• Another maybe cleaner way is to have another docker-compose "service" running parallel to "hfla_site" jekyll one to have it watch for code changes and run the linters. This way, both are running but in separate containers. docker-compose up will show outputs from both containers. Or they can be started or monitored separately using the relevant docker-compose commands. This is basically using another Dockerfile.lint that runs the linters.

[liamtirney]

per 1.6.a in CONTRIBUTING.md: "NOTE: If it takes longer than 2 minutes to build your website using docker-compose up, please let the technical leads know about this and add your website build time in a comment to #1443. Also, once you are part of the merge team, you can work on #1443 and fix it (if you want)."

running 'docker-compose up' successfully for the first time took longer than 2 minutes for me. It took about 5 minutes. Here's a snapshot of my terminal:

[kevin31yu]

per 1.6.a in CONTRIBUTING.md: "NOTE: If it takes longer than 2 minutes to build your website using docker-compose up, please let the technical leads know about this and add your website build time in a comment to #1443. Also, once you are part of the merge team, you can work on #1443 and fix it (if you want)."

Took up to 4 minutes by running 'docker-compose up'.