feat: Adding Docker Compose for local dev #3847
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request updates the Starlight project by modifying its container setup and task list. The Dockerfile now uses the Node.js image instead of the previous Bun image, switching the dependency installation from Bun to npm and updating the run command. A new Docker Compose configuration is added to define a "web" service with volume bindings and development settings. Additionally, the TODO file reflects progress on local development and documentation parity tasks. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant DC as Docker Compose
participant Img as Docker Image (Dockerfile)
participant App as Node.js Application
Dev->>DC: Run "docker-compose up"
DC->>Img: Build image using Dockerfile (FROM node:22)
Img->>Img: Execute "npm install"
Img->>App: Run "npm run dev -- --host 0.0.0.0"
App->>DC: Listen on port 4321
Poem
Tip 🌐 Web search-backed reviews and chat
🪧 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
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
🧹 Nitpick comments (2)
docs-starlight/TODO.md (2)
8-11: Markdown Indentation: Infrastructure Section Needs Tweaking
The markdownlint tool flags MD007 issues here. It looks like the top-level list items (lines 8–9) have an extra leading space, and the nested items (lines 10–11) have one space too many. Aligning these entries to the expected indentation (0 spaces for top-level and 2 spaces for nested items) will clear the warnings.Would you like a diff suggestion to standardize the markdown list formatting in this section?
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
9-9: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
14-16: Markdown Indentation: Content Section Adjustments
Similarly, the MD007 warnings indicate that the list items in the Content section need alignment adjustments. The top-level content item (line 14) and its nested entries (lines 15–16) currently have one extra space. Correcting the indentation to meet the expected levels will improve readability and comply with linting rules.Let me know if you’d like a diff suggestion for these adjustments.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
14-14: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs-starlight/Dockerfile(1 hunks)docs-starlight/TODO.md(1 hunks)docs-starlight/docker-compose.yml(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs-starlight/TODO.md
8-8: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
9-9: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: unessential
- GitHub Check: build-and-test
- GitHub Check: Pull Request has non-contributor approval
🔇 Additional comments (2)
docs-starlight/docker-compose.yml (1)
1-14: Docker Compose Setup is Spot On!
This configuration clearly defines awebservice with a proper build context, live reload volume mappings (including an exclusion for node_modules), port exposure for the Astro dev server, and the appropriate NODE_ENV setting for development. Great work in streamlining the local dev experience for the docs!docs-starlight/Dockerfile (1)
17-28: Smooth Transition to Node.js!
Switching from the previous Bun-based image tonode:22is handled well. The updated commands—usingnpm installfor dependency installation andnpm run dev -- --host 0.0.0.0for starting the development server—ensure that the container exposes the app correctly for local testing. The helpful comment about the Bun bug provides useful context too.
Description
Adds a
docker-compose.ymlandDockerfileto thedocs-starlightdirectory to allow for local development of the Starlight documentation site without installing anything else.TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Added Docker Compose setup for
docs-starlight.Summary by CodeRabbit