How to Integrate Git with Docker? (Using .dockerignore and .gitignore)

.dockeringore and .gitignore cannot replace each other, because they have different objects and timings: the former controls context transfer during build, and the latter controls code repository submission, ignoring that the rules are not interoperable and the grammatical behavior is different.

Why .dockerignore and .gitignore are not replacements for each other

Because their targets and timing are completely different: .gitignore controls which files will not be entered into the Git repository, while .dockerignore controls which files will not be sent to the Docker daemon during docker build . Even if a file is excluded by .gitignore , Docker may still package it as long as it exists in the build context directory - this will slow down the build, expose sensitive information, and even cause the image to fail to start.

• Common errors: COPY . /app in Dockerfile brings node_modules or .env into the image, but the local git status shows that these files are not tracked at all.
• Usage scenario: In the CI/CD pipeline, the Git warehouse is cloned and directly docker build . At this time, the build context is the entire working directory, .dockerignore is the only line of defense.
• Performance impact: Ignoring large directories (such as dist/ , __pycache__/ ) can significantly reduce the context transfer volume, especially on remote builders (such as GitHub Actions' docker/build-push-action ).

How to write .dockerignore and easy-to-miss paths

Its syntax is similar to .gitignore , but its behavior is simpler - it only supports prefix matching and does not support ** wildcarding (Docker 24.0 started experimental support, but most production environments still use the old version). The most critical thing is: it does not read .dockerignore in the subdirectory, only the one in the root directory.

• Must be explicitly ignored: node_modules/ (the trailing slash indicates the directory), .git , .DS_Store , README.md (if it is not needed in the image)
• Easy pitfalls: log/ can ignore ./log/ , but cannot ignore src/log/ ; it must be written as **/log/ (for compatibility with older versions, two lines can be written: log/ and */log/ )
• Pay attention to the order: the previous rules will not overwrite the following ones, but blank lines and comments starting with # will be skipped; ! Negation is only valid for the immediately next line, use with caution

How to coordinate when Git and Docker ignore policy conflicts

A typical conflict is: you want .env to be neither included in Git nor the image, but you need it to exist during development - then both .gitignore and .dockerignore should write it, but the Docker build command itself must bypass this restriction (such as using --secret or mounting method injection).

• Usage scenario: multi-environment deployment, .env.production is ignored in Git, but safe injection is required during CI build
• Parameter differences: docker build --secret id=env,src=.env.production . It is safer than forcing .env into the image; correspondingly, .env must still be retained in .dockerignore
• Compatibility impact: Older versions of Docker (--secret and can only rely on the build parameter --build-arg to pass the value. However, this method will leave the value in the image layer history. Be sure to avoid passing the key.

Practical method to verify whether .dockerignore is effective

Don't just look at whether the file is listed in git status , make sure it is not included in the build context. The most direct way is to temporarily change Dockerfile and add a step to check the command.

• Practical suggestions: Insert RUN find . -name ".env" -o -name "node_modules" | head -20 at the beginning Dockerfile , and then docker build --no-cache . Check whether the output is empty
• Common error phenomenon: Sending build context to Docker daemon 125.6MB appears in the build log, and the number is far higher than expected - indicating that .dockerignore does not work. It is most likely that the path is written wrong or the location is wrong (it must be placed in the directory where docker build is located)
• Debugging skills: run tar -cf - . | tar -t | grep -E "(node_modules|\.env)" | head -10 to simulate the process of Docker packaging context and quickly locate fish that have slipped through the net

The real trouble is not writing a wrong line of rules, but the default trust that "since Git doesn't care about it, Docker should not care about it either" - this assumption is almost always wrong in the containerization process.

The above is the detailed content of How to Integrate Git with Docker? (Using .dockerignore and .gitignore). For more information, please follow other related articles on the PHP Chinese website!