Skip to content

fix: preserve Dockerfile-specific .dockerignore files#1206

Open
lawrence3699 wants to merge 1 commit intodevcontainers:mainfrom
lawrence3699:fix/preserve-dockerignore-temp-dockerfile
Open

fix: preserve Dockerfile-specific .dockerignore files#1206
lawrence3699 wants to merge 1 commit intodevcontainers:mainfrom
lawrence3699:fix/preserve-dockerignore-temp-dockerfile

Conversation

@lawrence3699
Copy link
Copy Markdown

Fixes #969

Summary

  • copy the source Dockerfile's sibling .dockerignore file next to the generated Dockerfile-with-features
  • apply the same fix to both compose-backed builds and direct Dockerfile builds, since both paths rewrite Dockerfiles into a temp folder before building
  • add focused regression coverage for a compose build that uses a non-standard Dockerfile name

Why this is correct

When the CLI rewrites a Dockerfile into a temp folder, Docker stops seeing the original <Dockerfile>.dockerignore file because it only looks for Dockerfile-specific ignore files next to the Dockerfile it is actually building. Copying that sibling file alongside the generated Dockerfile preserves Docker's existing lookup and precedence rules.

Validation

  • focused ts-node repro around buildAndExtendDockerCompose: before the patch the generated temp Dockerfile had no sibling .dockerignore; after the patch it does, with the original contents preserved
  • ./node_modules/.bin/tsc -b
  • ./node_modules/.bin/eslint src/spec-node/dockerCompose.ts src/spec-node/singleContainer.ts src/spec-node/dockerignoreUtils.ts src/test/dockerignore.test.ts

I could not run the Docker-backed CLI test suite in this environment because Docker is not installed here.

Copilot AI review requested due to automatic review settings April 19, 2026 18:17
@lawrence3699 lawrence3699 requested a review from a team as a code owner April 19, 2026 18:17
@microsoft-github-policy-service
Copy link
Copy Markdown

@lawrence3699 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes devcontainer builds so Dockerfile-specific ignore files (e.g. dev.Dockerfile.dockerignore) continue to apply when the CLI rewrites the Dockerfile into a temp folder (e.g. Dockerfile-with-features), aligning behavior with Docker’s documented .dockerignore lookup rules.

Changes:

  • Copy <source Dockerfile>.dockerignore alongside the generated Dockerfile-with-features for direct Dockerfile builds.
  • Apply the same .dockerignore preservation for compose-backed builds when generating the compose build override Dockerfile.
  • Add a regression test covering a compose build that uses a non-standard Dockerfile name.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/spec-node/dockerignoreUtils.ts Adds helper to copy Dockerfile-specific .dockerignore to the generated Dockerfile location.
src/spec-node/singleContainer.ts Calls the helper when generating Dockerfile-with-features for direct Dockerfile builds.
src/spec-node/dockerCompose.ts Calls the helper for compose builds after writing Dockerfile-with-features.
src/test/dockerignore.test.ts Adds regression coverage ensuring the generated compose Dockerfile has the sibling .dockerignore.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +34 to +36
const fakeDocker = path.join(root, 'fake-docker');
await fs.writeFile(fakeDocker, `#!/bin/sh
set -eu
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test creates a fake docker executable as a #!/bin/sh script and relies on chmod + shebang execution. That approach will fail on Windows when running tests via Node’s child_process.spawn (even under Git Bash), because Windows cannot directly execute shebang scripts without an explicit interpreter. Consider generating a cross-platform fake (e.g. a small Node.js .js script invoked via node, or a .cmd wrapper on win32), or skipping this test on process.platform === 'win32'.

Copilot uses AI. Check for mistakes.
const { context, dockerfilePath, target } = serviceInfo.build;
const resolvedDockerfilePath = cliHost.path.isAbsolute(dockerfilePath) ? dockerfilePath : path.resolve(context, dockerfilePath);
const originalDockerfile = (await cliHost.readFile(resolvedDockerfilePath)).toString();
sourceDockerfilePath = cliHost.path.isAbsolute(dockerfilePath) ? dockerfilePath : path.resolve(context, dockerfilePath);
Copy link

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sourceDockerfilePath is resolved using Node's path.resolve(...) even though the rest of the compose path handling uses cliHost.path (which can be posix/win32 depending on the host). This can produce incorrect paths when the CLI host path semantics differ from the local Node process (e.g. WSL/remote scenarios), and would prevent reading/copying the Dockerfile-specific .dockerignore. Use cliHost.path.resolve(context, dockerfilePath) (and avoid mixing path and cliHost.path) to keep resolution consistent.

Suggested change
sourceDockerfilePath = cliHost.path.isAbsolute(dockerfilePath) ? dockerfilePath : path.resolve(context, dockerfilePath);
sourceDockerfilePath = cliHost.path.isAbsolute(dockerfilePath) ? dockerfilePath : cliHost.path.resolve(context, dockerfilePath);

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Building devcontainers does not use .dockerignore file next to the Dockerfile.

2 participants