file inclusion improvement + docs

core/src/graph/actions.ts

@@ -250,8 +250,9 @@ export const actionFromConfig = profileAsync(async function actionFromConfig({
     }
   }
 
+  const configPath = relative(garden.projectRoot, config.internal.configFilePath || config.internal.basePath)
+
   if (!actionTypes[config.kind][config.type]) {
-    const configPath = relative(garden.projectRoot, config.internal.configFilePath || config.internal.basePath)
     const availableKinds: ActionKind[] = []
     actionKinds.forEach((actionKind) => {
       if (actionTypes[actionKind][config.type]) {
@@ -282,6 +283,18 @@ export const actionFromConfig = profileAsync(async function actionFromConfig({
 
   const dependencies = dependenciesFromActionConfig(log, config, configsByKey, definition, templateContext)
 
+  if (config.exclude?.includes("**/*")) {
+    if (config.include && config.include.length !== 0) {
+      throw new ConfigurationError({
+        message: deline`Action ${config.kind}.${config.name} (defined at ${configPath})
+        tries to include files but excludes all files via "**/*".
+        Read about including and excluding files and directories here:
+        https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories`,
+      })
+    }
+    config.include = []
+  }
+
   const treeVersion =
     config.internal.treeVersion ||
     (await garden.vcs.getTreeVersion({ log, projectName: garden.projectName, config, scanRoot }))

core/src/vcs/git.ts

@@ -260,7 +260,8 @@ export class GitHandler extends VcsHandler {
     if (!exclude) {
       exclude = []
     }
-    exclude.push("**/.garden/**/*")
+    // Make sure action config is not mutated
+    exclude = [...exclude, "**/.garden/**/*"]
 
     const gitLog = log
       .createLog({})

core/test/unit/src/actions/action-configs-to-graph.ts

@@ -17,7 +17,7 @@ import {
   DEFAULT_BUILD_TIMEOUT_SEC,
   DEFAULT_DEPLOY_TIMEOUT_SEC,
   DEFAULT_RUN_TIMEOUT_SEC,
-  DEFAULT_TEST_TIMEOUT_SEC
+  DEFAULT_TEST_TIMEOUT_SEC,
 } from "../../../../src/constants"
 
 describe("actionConfigsToGraph", () => {
@@ -769,4 +769,76 @@ describe("actionConfigsToGraph", () => {
       }
     )
   })
+
+  describe("file inclusion-exclusion", () => {
+    const getBaseParams = ({
+      include,
+      exclude,
+    }: {
+      include?: string[]
+      exclude?: string[]
+    }) => ({
+      garden,
+      log,
+      groupConfigs: [],
+      configs: [
+        {
+          kind: <"Build">"Build",
+          type: <"test">"test",
+          name: "foo",
+          timeout: DEFAULT_BUILD_TIMEOUT_SEC,
+          internal: {
+            basePath: tmpDir.path,
+          },
+          spec: {},
+
+          include,
+          exclude,
+        },
+      ],
+      moduleGraph: new ModuleGraph([], {}),
+      actionModes: {},
+      linkedSources: {},
+    })
+
+    it("sets include and exclude", async () => {
+      const graph = await actionConfigsToGraph({
+        ...getBaseParams({
+          include: ["include-file"],
+          exclude: ["exclude-file"],
+        }),
+      })
+      const action = graph.getBuild("foo")
+
+      expect(action.getConfig().include).to.eql(["include-file"])
+      expect(action.getConfig().exclude).to.eql(["exclude-file"])
+    })
+
+    it("sets include to [] if all is excluded", async () => {
+      const graph = await actionConfigsToGraph({
+        ...getBaseParams({
+          include: undefined,
+          exclude: ["**/*", "some-thing-else"],
+        }),
+      })
+      const action = graph.getBuild("foo")
+
+      expect(action.getConfig().include).to.eql([])
+    })
+
+    it("throws if everything is excluded but an include is attempted", async () => {
+      await expectError(
+        () =>
+          actionConfigsToGraph({
+            ...getBaseParams({
+              include: ["some-file"],
+              exclude: ["**/*"],
+            }),
+          }),
+        {
+          contains: ['tries to include files but excludes all files via "**/*"'],
+        }
+      )
+    })
+  })
 })

docs/using-garden/actions.md

@@ -165,6 +165,12 @@ exclude:
 ...
 ```
 
+{% hint style="info" %}
+Generally, using `.gardenignore` files is far more performant than exclude config statements and will decrease
+graph resolution time. Read more about `.gardenignore` files in the 
+[configuration-overview documentation](./configuration-overview.md#includingexcluding-files-and-directories)
+{% endhint %}
+
 Here we only include the `Dockerfile` and all the `.py` files under `my-sources/`, but exclude the `my-sources/tmp`
 directory.
 

docs/using-garden/configuration-overview.md

@@ -59,8 +59,9 @@ The `scan.exclude` field is also used to limit the number of files and directori
 
 ### .ignore file
 
-{% hint style="warning" %}
-Prior to Garden 0.12.0, `.gitignore` files were also respected by default. The default is now to only respect `.gardenignore` files. See below how you can revert to the previous behavior.
+{% hint style="info" %}
+Generally, using .gardenignore files is far more performant than exclude config statements and will decrease
+graph resolution time.
 {% endhint %}
 
 By default, Garden respects `.gardenignore` files and excludes any patterns matched in those files. You can place the ignore files anywhere in your repository, much like `.gitignore` files, and they will follow the same semantics.