fix(docker): correct docker composes for prod and preprod #768
Conversation
WalkthroughThe recent updates enhance the configuration of the "werewolves-assistant" application, specifically for preproduction and production environments. Key improvements include the introduction of environment variables for the Nuxt pre-rendering feature, refined Docker image tags, and adjustments to port mappings. These changes aim to provide clearer documentation and facilitate smoother deployment processes across different environments, improving overall functionality and flexibility. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Web Service
participant API Service
User->>Web Service: Request data
Web Service->>API Service: Fetch data from API
API Service-->>Web Service: Return data
Web Service-->>User: Send response
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
README.md (1)
446-447: Consider rephrasing for stylistic variety.LanguageTool suggests varying the phrasing to avoid repetition. Consider rephrasing for enhanced readability.
- If you want to test the app with the latest features, you can use the `preprod` tags. - If you want to test the app with the latest release, you can use the `prod` tags. + To test the app with the latest features, use the `preprod` tags. + To test the app with the latest release, use the `prod` tags.Tools
LanguageTool
[style] ~446-~446: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...with the API running locally. - If you want to test the app with the latest features, ...(REP_WANT_TO_VB)
[style] ~447-~447: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ou can use thepreprodtags. - If you want to test the app with the latest release, y...(REP_WANT_TO_VB)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- README.md (2 hunks)
- docker/werewolves-assistant-preproduction-example/docker-compose.yml (2 hunks)
- docker/werewolves-assistant-production-example/docker-compose.yml (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~446-~446: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...with the API running locally. - If you want to test the app with the latest features, ...(REP_WANT_TO_VB)
[style] ~447-~447: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ou can use thepreprodtags. - If you want to test the app with the latest release, y...(REP_WANT_TO_VB)
Additional comments not posted (7)
docker/werewolves-assistant-production-example/docker-compose.yml (3)
29-29: Port mapping update approved.The port mapping for the API service has been updated to
9191:9191, aligning with the new port configuration.
6-9: Ensure environment variables are correctly configured.The
NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URLandNUXT_PUBLIC_DEFAULT_LOCALEenvironment variables have been added. Verify that these values are appropriate for the production environment.
15-22: Verify port change consistency.The API service port has been changed to
9191. Ensure this change is consistently applied across all relevant configurations and documentation.docker/werewolves-assistant-preproduction-example/docker-compose.yml (3)
11-11: Port mapping update approved.The port mapping for the front service has been updated to
3001:3000, aligning with preproduction requirements.
41-41: Port mapping update approved.The port mapping for the MongoDB service has been updated to
29001:27017, aligning with preproduction requirements.
7-9: Verify preproduction environment variables.The
NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URLandNUXT_PUBLIC_DEFAULT_LOCALEhave been added. Ensure these values are suitable for the preproduction environment.README.md (1)
Line range hint
424-449: Clarify Docker tag usage and environment variable injection.The documentation updates provide clearer guidance on Docker tags and environment variable injection for the Nuxt pre-rendering feature. Ensure these changes accurately reflect the Docker configuration and provide clear instructions for users.
Verification successful
Documentation Consistency Verified for Docker Tags
The documentation for Docker tags and commands in the README.md is consistent with the definitions found in the
package.jsonfile. The commands are accurately described and align with their intended usage in the codebase. No discrepancies were found.
docker:preproduction-example:startanddocker:production-example:startare correctly documented.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy of Docker tag documentation. # Test: Search for Docker tag references in the codebase. Expect: Consistency with documentation. rg --type markdown 'docker:preproduction-example:start|docker:production-example:start'Length of output: 194
Script:
#!/bin/bash # Description: Check for the definitions of Docker commands in project scripts or configuration files. # Test: Search for Docker command definitions in the codebase. rg 'docker:preproduction-example:start|docker:production-example:start' -g '*.json' -g '*.yml' -g '*.yaml' -g '*.sh' -g '*.js'Length of output: 707
Tools
LanguageTool
[style] ~446-~446: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...with the API running locally. - If you want to test the app with the latest features, ...(REP_WANT_TO_VB)
[style] ~447-~447: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ou can use thepreprodtags. - If you want to test the app with the latest release, y...(REP_WANT_TO_VB)
|
## [1.29.0](v1.28.0...v1.29.0) (2024-08-20) ### 🚀 Features * **actor:** actor playground and events ([#747](#747)) ([6c9a034](6c9a034)) * **game-lobby:** thief and actor cards confirm steps ([#760](#760)) ([11a9bd5](11a9bd5)) ### 🐛 Bug Fixes * **buttons:** correct icon slots ([#759](#759)) ([3bfbab9](3bfbab9)) * **docker:** correct docker composes for prod and preprod ([#768](#768)) ([89175cd](89175cd)) ### 📖 Docs * **docker:** explain dockers tags created ([#767](#767)) ([334cc80](334cc80)) ### 🔁 CI * **docker:** push multiple prebuilt images ([32838b1](32838b1)) ### 🧹 Chore * **deps:** update dependency @eslint/config-inspector to ^0.5.3 ([#750](#750)) ([d99ea7c](d99ea7c)) * **deps:** update dependency @eslint/config-inspector to ^0.5.4 ([#761](#761)) ([0196025](0196025)) * **deps:** update dependency @nuxtjs/i18n to ^8.4.0 ([#753](#753)) ([84a86f8](84a86f8)) * **deps:** update dependency @stylistic/eslint-plugin to ^2.6.4 ([#751](#751)) ([8899923](8899923)) * **deps:** update dependency @vueuse/core to ^11.0.1 ([#762](#762)) ([be4784d](be4784d)) * **deps:** update dependency @vueuse/core to v11 ([#754](#754)) ([b1c25df](b1c25df)) * **deps:** update dependency @vueuse/nuxt to ^11.0.1 ([#763](#763)) ([c66613f](c66613f)) * **deps:** update dependency @vueuse/nuxt to v11 ([#755](#755)) ([b3abc86](b3abc86)) * **deps:** update dependency pinia to ^2.2.2 ([#752](#752)) ([96d7032](96d7032)) * **deps:** update dependency semantic-release to ^24.1.0 ([#758](#758)) ([b109f4f](b109f4f)) * **deps:** update dependency type-fest to ^4.25.0 ([#757](#757)) ([c64b715](c64b715)) * **deps:** update dependency vue to ^3.4.38 ([#749](#749)) ([9ceb602](9ceb602)) * **deps:** update playwright monorepo to ^1.46.1 ([#756](#756)) ([df3bf86](df3bf86)) * **deps:** update pnpm to v9.7.1 ([#746](#746)) ([6803a0d](6803a0d)) * **deps:** update typescript-eslint monorepo to ^8.2.0 ([#766](#766)) ([211953e](211953e))
|
🎉 This PR is included in version 1.29.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Summary by CodeRabbit
Documentation
New Features
Production Updates