Documentation and changeset

jpmorganchase · May 17, 2023 · 6209e17 · 6209e17
1 parent 0605ea0
commit 6209e17
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.changeset/eight-bats-double.md b/.changeset/eight-bats-double.md
@@ -0,0 +1,6 @@
+---
+'modular-scripts': major
+---
+
+Modular's workspace resolver now ignores a workspace if covered by a
+.modularignore or .gitignore (.modularignore overrides .gitignore)
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -121,3 +121,9 @@ _e.g._
 The `package.json#modular.type` can be `"root"`, `"app"`, `"view"`,
 `"esm-view"`, `"source"`, `"template"` or `"package"`. Read more about Modular
 types in [this explainer](/docs/package-types).
+
+## `.modularignore` & `.gitignore`
+
+Modular respects `.gitignore` when identifying workspaces in the repository,
+ignoring any workspaces covered by the repo's `.gitignore`. This behavior can be
+overridden by providing a `.modularignore`.