refactor: create a docker compose and replace mounting with develop #3943
Conversation
nightknighto
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
quetzalliwrites and
sambhavgupta0705
as code owners
WalkthroughThe changes streamline the Docker development setup. The README now instructs users to run the project with a single command ( Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Compose as Docker Compose
participant Daemon as Docker Daemon
participant Website as Website Container
Dev->>Compose: Run "docker compose up --watch"
Compose->>Daemon: Build and configure services (including "website")
Daemon->>Website: Build container with specified context, port and sync settings
Website-->>Daemon: Container started and ready
Assessment against linked issues
Poem
🪧 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3943 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![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
🧹 Nitpick comments (2)
docker-compose.yaml (1)
1-11: Docker Compose Service Configuration ReviewThe service definition for
websiteis generally well structured and meets the objective of streamlining the Dockerized development workflow. However, please verify that the propertypull_policy: build(line 6) is supported by your version of Docker Compose. This key is more common in Kubernetes (asimagePullPolicy) and might not be recognized in a standard Docker Compose file.README.md (1)
123-128: Improve Clarity in Docker Compose InstructionsThe instructions on running Docker Compose can be made clearer by adding the missing article and adjusting the phrasing. For example, consider revising the sentence for better readability and accuracy.
Below is a proposed diff:
-After cloning repository to your local, run the docker compose from the root of the repository. +After cloning the repository to your local machine, navigate to the root of the repository and run:And ensure the following command block remains:
docker compose up🧰 Tools
🪛 LanguageTool
[uncategorized] ~123-~123: You might be missing the article “the” here.
Context: ...docker.com/get-docker/) After cloning repository to your local, run the docker compose f...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~123-~123: The usual collocation for “compose” is “of”, not “from”. Did you mean “compose of”?
Context: ...epository to your local, run the docker compose from the root of the repository. ```bash d...(COMPOSE_FROM_OF)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)docker-compose.yaml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~123-~123: You might be missing the article “the” here.
Context: ...docker.com/get-docker/) After cloning repository to your local, run the docker compose f...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~123-~123: The usual collocation for “compose” is “of”, not “from”. Did you mean “compose of”?
Context: ...epository to your local, run the docker compose from the root of the repository. ```bash d...
(COMPOSE_FROM_OF)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docker-compose.yaml (1)
1-16: Service configuration and custom keys review:
The newwebsiteservice is set up correctly with container naming, image assignment, build context, and port mapping. However, note that the propertiespull_policyanddevelop(with its nestedwatchconfiguration) are not part of the official Docker Compose specification. Make sure that these keys are supported by your current Docker Compose version or custom tooling. It would be beneficial to add inline comments or update the documentation to explain their purpose and behavior for future maintainability.README.md (1)
123-129: Clarify and polish Docker instruction text:
The updated instructions for running the project in Docker watch mode align well with the new service configuration indocker-compose.yaml. Consider rephrasing the sentence on line 123 for improved clarity. For example, change:-After cloning repository to your local, run the docker compose in watch mode from the root of the repository. +After cloning the repository locally, run docker compose in watch mode from the repository root.This small refinement enhances readability and professionalism.
🧰 Tools
🪛 LanguageTool
[style] ~129-~129: Consider shortening or rephrasing this to strengthen your wording.
Context: ...local copy of the website. Whenever you make changes to the code, the website will refresh and ...(MAKE_CHANGES)
|
i have also upgraded docker file too for better build let me know if you would like to see it |
|
@lohargaurav00 This feature doesn't need an update in the Dockerfile. If you have improvements for the Dockerfile, feel free to open a new issue. |
|
@anshgoyalevil @AceTheCreator hello. could you please have a look at this PR? |
devilkiller-ag
left a comment
devilkiller-ag
left a comment
There was a problem hiding this comment.
The docker-compose setup looks good to me.
There was a problem hiding this comment.
@nightknighto Please update the branch, and re-run failing tests.
|
@devilkiller-ag Done |
|
@nightknighto update the branch |
|
@vishvamsinh28 done |
|
@anshgoyalevil could you also take a look at this PR ? |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3943--asyncapi-website.netlify.app/ |
|
@devilkiller-ag @vishvamsinh28 @anshgoyalevil @thulieblack |
8 participants
Description
Improves the Dockerized development workflow of the project.
Related issue(s)
Fixes #3919
Screenshots
Screenshot showcasing changes being transferred and the development server refreshing.
Summary by CodeRabbit
Documentation
New Features