Document CopyIgnoredFile check as initially experimental.

Signed-off-by: Talon Bowler <talon.bowler@docker.com>
moby · Jul 10, 2024 · 71ac772 · 71ac772
1 parent 91eb1d7
commit 71ac772
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 38 deletions.
diff --git a/frontend/dockerfile/dockerfile2llb/convert.go b/frontend/dockerfile/dockerfile2llb/convert.go
@@ -600,7 +600,7 @@ func toDispatchState(ctx context.Context, dt []byte, opt ConvertOpt) (*dispatchS
 	if err != nil {
 		return nil, err
 	}
-	if len(dockerIgnorePatterns) > 0 {
+	if len(dockerIgnorePatterns) > 0 && opt.Client.CopyIgnoredCheckEnabled {
 		dockerIgnoreMatcher, err = patternmatcher.New(dockerIgnorePatterns)
 		if err != nil {
 			return nil, err
@@ -651,24 +651,23 @@ func toDispatchState(ctx context.Context, dt []byte, opt ConvertOpt) (*dispatchS
 		d.state = d.state.Network(opt.NetworkMode)
 
 		opt := dispatchOpt{
-			allDispatchStates:       allDispatchStates,
-			metaArgs:                optMetaArgs,
-			buildArgValues:          opt.BuildArgs,
-			shlex:                   shlex,
-			buildContext:            llb.NewState(buildContext),
-			proxyEnv:                proxyEnv,
-			cacheIDNamespace:        opt.CacheIDNamespace,
-			buildPlatforms:          platformOpt.buildPlatforms,
-			targetPlatform:          platformOpt.targetPlatform,
-			extraHosts:              opt.ExtraHosts,
-			shmSize:                 opt.ShmSize,
-			ulimit:                  opt.Ulimits,
-			cgroupParent:            opt.CgroupParent,
-			llbCaps:                 opt.LLBCaps,
-			sourceMap:               opt.SourceMap,
-			lint:                    lint,
-			dockerIgnoreMatcher:     dockerIgnoreMatcher,
-			copyIgnoredCheckEnabled: opt.Client.CopyIgnoredCheckEnabled,
+			allDispatchStates:   allDispatchStates,
+			metaArgs:            optMetaArgs,
+			buildArgValues:      opt.BuildArgs,
+			shlex:               shlex,
+			buildContext:        llb.NewState(buildContext),
+			proxyEnv:            proxyEnv,
+			cacheIDNamespace:    opt.CacheIDNamespace,
+			buildPlatforms:      platformOpt.buildPlatforms,
+			targetPlatform:      platformOpt.targetPlatform,
+			extraHosts:          opt.ExtraHosts,
+			shmSize:             opt.ShmSize,
+			ulimit:              opt.Ulimits,
+			cgroupParent:        opt.CgroupParent,
+			llbCaps:             opt.LLBCaps,
+			sourceMap:           opt.SourceMap,
+			lint:                lint,
+			dockerIgnoreMatcher: dockerIgnoreMatcher,
 		}
 
 		if err = dispatchOnBuildTriggers(d, d.image.Config.OnBuild, opt); err != nil {
@@ -827,24 +826,23 @@ func toCommand(ic instructions.Command, allDispatchStates *dispatchStates) (comm
 }
 
 type dispatchOpt struct {
-	allDispatchStates       *dispatchStates
-	metaArgs                []instructions.KeyValuePairOptional
-	buildArgValues          map[string]string
-	shlex                   *shell.Lex
-	buildContext            llb.State
-	proxyEnv                *llb.ProxyEnv
-	cacheIDNamespace        string
-	targetPlatform          ocispecs.Platform
-	buildPlatforms          []ocispecs.Platform
-	extraHosts              []llb.HostIP
-	shmSize                 int64
-	ulimit                  []pb.Ulimit
-	cgroupParent            string
-	llbCaps                 *apicaps.CapSet
-	sourceMap               *llb.SourceMap
-	lint                    *linter.Linter
-	dockerIgnoreMatcher     *patternmatcher.PatternMatcher
-	copyIgnoredCheckEnabled bool
+	allDispatchStates   *dispatchStates
+	metaArgs            []instructions.KeyValuePairOptional
+	buildArgValues      map[string]string
+	shlex               *shell.Lex
+	buildContext        llb.State
+	proxyEnv            *llb.ProxyEnv
+	cacheIDNamespace    string
+	targetPlatform      ocispecs.Platform
+	buildPlatforms      []ocispecs.Platform
+	extraHosts          []llb.HostIP
+	shmSize             int64
+	ulimit              []pb.Ulimit
+	cgroupParent        string
+	llbCaps             *apicaps.CapSet
+	sourceMap           *llb.SourceMap
+	lint                *linter.Linter
+	dockerIgnoreMatcher *patternmatcher.PatternMatcher
 }
 
 func getEnv(state llb.State) shell.EnvGetter {
@@ -1898,7 +1896,7 @@ func addReachableStages(s *dispatchState, stages map[*dispatchState]struct{}) {
 }
 
 func validateCopySourcePath(src string, cfg *copyConfig) error {
-	if cfg.ignoreMatcher == nil || !cfg.opt.copyIgnoredCheckEnabled {
+	if cfg.ignoreMatcher == nil {
 		return nil
 	}
 	cmd := "Copy"

diff --git a/frontend/dockerui/config.go b/frontend/dockerui/config.go
@@ -289,6 +289,9 @@ func (bc *Client) init() error {
 		}
 	}
 
+	// CopyIgnoredCheckEnabled is an experimental feature to check if COPY is ignored by .dockerignore,
+	// and it is disabled by default. It is expected that this feature will be enabled by default in a future
+	// release, and this build-arg will be removed.
 	if v, ok := opts[keyCopyIgnoredCheckEnabled]; ok {
 		bc.CopyIgnoredCheckEnabled, err = strconv.ParseBool(v)
 		if err != nil {