Add a note about sourceignore recursion

Signed-off-by: Kingdon Barrett <kingdon@weave.works>
fluxcd · Jan 27, 2023 · 3b4ab58 · 3b4ab58
1 parent a56a888
commit 3b4ab58
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/spec/v1beta2/buckets.md b/docs/spec/v1beta2/buckets.md
@@ -727,6 +727,8 @@ object storage bucket. The `.sourceignore` file follows [the `.gitignore`
 pattern format](https://git-scm.com/docs/gitignore#_pattern_format), and
 pattern entries may overrule [default exclusions](#default-exclusions).
 
+The `.sourceignore` must be in the root directory for `Bucket` sources.
+
 #### Ignore spec
 
 Another option is to define the exclusions within the Bucket spec, using the

diff --git a/docs/spec/v1beta2/gitrepositories.md b/docs/spec/v1beta2/gitrepositories.md
@@ -487,6 +487,9 @@ repository. The `.sourceignore` file follows [the `.gitignore` pattern
 format](https://git-scm.com/docs/gitignore#_pattern_format), and
 pattern entries may overrule [default exclusions](#default-exclusions).
 
+The controller recursively loads ignore files so a `.sourceignore` can be
+placed in the repository root or in subdirectories.
+
 #### Ignore spec
 
 Another option is to define the exclusions within the GitRepository spec, using

diff --git a/docs/spec/v1beta2/ocirepositories.md b/docs/spec/v1beta2/ocirepositories.md
@@ -526,6 +526,16 @@ spec:
     /deploy/**/*.txt
 ```
 
+#### `.sourceignore` file
+
+Excluding files is possible by adding a `.sourceignore` file in the artifact.
+The `.sourceignore` file follows [the `.gitignore` pattern
+format](https://git-scm.com/docs/gitignore#_pattern_format), and pattern
+entries may overrule [default exclusions](#default-exclusions).
+
+The controller recursively loads ignore files so a `.sourceignore` can be
+placed in the artifact root or in subdirectories.
+
 ### Triggering a reconcile
 
 To manually tell the source-controller to reconcile a OCIRepository outside the