refactor: Consolidate to single universal Dockerfile with BUILD_ENV argument #569
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR simplifies Docker configuration by replacing two separate Dockerfiles with a single unified Dockerfile using build targets. ## Changes ### Files Added: - `Dockerfile.unified` - New unified Dockerfile with 'development' and 'production' targets ### Files Modified: - `docker-compose.yaml` - Updated to use unified Dockerfile with explicit targets - `.dockerignore` - Keep ignoring Dockerfile.dev specifically - `.github/workflows/docker-validate.yml` - Updated to lint unified Dockerfile - `README.md` - Updated Docker documentation to reflect unified approach ### Files To Remove (in next commit): - `Dockerfile` (old production-only) - `Dockerfile.dev` (old development-only) ## Benefits 1. **Single Source of Truth**: One Dockerfile to maintain instead of two 2. **Shared Base Layers**: Common stages (base, deps, deps-dev) are reused 3. **Better Caching**: BuildKit can optimize shared layers between targets 4. **Simpler Maintenance**: Changes to Node/pnpm versions in one place 5. **Consistent Behavior**: Same base configuration for dev and prod ## How It Works The unified Dockerfile has 5 stages: - `base`: Common setup (Node.js, pnpm installation) - `deps`: Production dependencies only - `deps-dev`: All dependencies (including devDependencies) - `development` (TARGET): Dev server with hot-reload - `builder`: Builds Next.js static export - `production` (TARGET): Nginx serving static export Docker Compose automatically selects the correct target: - `dev` service → `development` target - `prod` service → `production` target ## Migration Path Existing users can continue using docker-compose without changes. Direct docker build commands need to specify `-f Dockerfile.unified` and `--target`. Once validated, we'll remove the old Dockerfiles in a follow-up commit.
Deploying devops-daily with
|
| Latest commit: |
984ff41
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://38124f9b.devops-daily.pages.dev |
| Branch Preview URL: | https://refactor-unified-dockerfile.devops-daily.pages.dev |
…rgument - Removed Dockerfile.unified and Dockerfile.dev - Created single Dockerfile that switches between dev/prod via BUILD_ENV - Simplified docker-compose.yaml to use BUILD_ENV instead of targets - Updated health checks to use curl for both environments - Updated .dockerignore to remove specific Dockerfile references - Updated docker validation workflow to lint new Dockerfile - Updated README documentation with simpler build commands - Architecture: One Dockerfile, two modes, controlled by single argument
bobbyonmagic
changed the title
- Add --no-install-recommends to apt-get install (DL3015) - Escape $uri variables in nginx config (SC2016) - Use JSON notation for CMD (DL3025) - Improves security and follows Docker best practices
DL3008 and SC2016 are ignored because: - Pinning apt package versions creates maintenance burden - System packages are upgraded for security (apt-get upgrade) - Echo statements for nginx config are properly escaped - These checks are too strict for our use case
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR simplifies Docker configuration to a single universal Dockerfile controlled by a simple
BUILD_ENVbuild argument. No more multi-stage targets, no more separate files - just one Dockerfile that switches between development and production modes.Problem
Previously, we had:
Dockerfile(~160 lines) - Production multi-stage buildDockerfile.dev(~47 lines) - Development single-stageDockerfile.unified(176 lines) - Multi-target approach withdevelopmentandproductiontargetsAll of this was overly complex for what should be a simple environment switch.
Solution
Created a single universal
Dockerfile(110 lines) controlled by:BUILD_ENV=production(default) - Installs nginx, builds assets, serves on port 80BUILD_ENV=development- Skips nginx, runs dev server on port 3000Changes
Added:
Dockerfilewith conditional logicModified:
docker-compose.yaml- UsesBUILD_ENVarg instead of targets.dockerignore- Removed specific Dockerfile references.github/workflows/docker-validate.yml- Lints new DockerfileREADME.md- Simplified Docker documentationRemoved:
Dockerfile.unified(multi-target approach)Dockerfile.dev(old development-only)Dockerfilereplaced with universal versionBenefits
BUILD_ENV)--build-arg BUILD_ENV=<mode>Architecture
Usage
Docker Compose (Recommended)
Direct Docker Build
Testing
Ready for review and testing!