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

Docker compose cleanup #2248

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

Jamie-Clayton
Copy link
Contributor

@Jamie-Clayton Jamie-Clayton commented Jun 23, 2024

What this PR does / why we need it:

  • Refactor the .env secrets file used by docker compose
  • Add instructions to the readme file for the solution to explain how to perform local testing of the code.
  • Add yaml-language-server references for a better developer experience.
  • WIP : More commits are required to get everything working in docker desktop.

Which issue(s) this PR fixes:

Special notes for your reviewer:

  • Recommend: Install the Redhat Yaml extension in Visual Code
  • Further .editorconfig preferences should be considered for yaml files.
[*.{yml,yaml}]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
spaces_around_brackets = true

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Created/updated tests
  • Unit tests passing
  • End-to-end tests passing
  • Extended the documentation
  • Provided sample for the feature

- Separate values into Ports and User/Password section
- Apply alphabetical sorting, thank Copilot.
- Include simple docker compose instructions.
- Uncovered automated tests failed locally, due to container status != running.
- Tests do take a while to execute locally.
- Provides a better developer experience in Visual Studio 2022 and Visual Code
- Recommend: Install the Redhat Yaml extension in Visual Code
@github-actions github-actions bot added the docs label Jun 23, 2024
@Jamie-Clayton Jamie-Clayton marked this pull request as draft June 23, 2024 22:38
* Include a discussion on the use of sensitive data in docker compose.
* Move to the end of the readme file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant