Allow to disregard gitignore file

spacelift-io · Jul 31, 2023 · e3f62ef · e3f62ef
1 parent d3eec79
commit e3f62ef
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 15 deletions.
diff --git a/internal/cmd/module/flags.go b/internal/cmd/module/flags.go
@@ -35,3 +35,8 @@ var flagVersion = &cli.StringFlag{
 	Usage: "Semver `version` for the module version. If not provided, the version " +
 		"from the configuration file will be used",
 }
+
+var flagDisregardGitignore = &cli.BoolFlag{
+	Name:  "disregard-gitignore",
+	Usage: "[Optional] Disregard the .gitignore file when reading files in a directory",
+}
diff --git a/internal/cmd/module/local_preview.go b/internal/cmd/module/local_preview.go
@@ -51,7 +51,12 @@ func localPreview() cli.ActionFunc {
 
 		fp := filepath.Join(os.TempDir(), "spacectl", "local-workspace", fmt.Sprintf("%s.tar.gz", uploadMutation.UploadLocalWorkspace.ID))
 
-		matchFn, err := internal.GetIgnoreMatcherFn(ctx, nil)
+		ignoreFiles := []string{".terraformignore"}
+		if !cliCtx.IsSet(flagDisregardGitignore.Name) {
+			ignoreFiles = append(ignoreFiles, ".gitignore")
+		}
+
+		matchFn, err := internal.GetIgnoreMatcherFn(ctx, nil, ignoreFiles)
 		if err != nil {
 			return fmt.Errorf("couldn't analyze .gitignore and .terraformignore files")
 		}

diff --git a/internal/cmd/module/module.go b/internal/cmd/module/module.go
@@ -35,6 +35,7 @@ func Command() *cli.Command {
 					flagNoFindRepositoryRoot,
 					flagNoUpload,
 					flagRunMetadata,
+					flagDisregardGitignore,
 				},
 				Action:    localPreview(),
 				Before:    authenticated.Ensure,

diff --git a/internal/cmd/stack/flags.go b/internal/cmd/stack/flags.go
@@ -124,3 +124,8 @@ var flagOverrideEnvVars = &cli.StringSliceFlag{
 	Name:  "env-var-override",
 	Usage: "[Optional] Environment variables injected into the run at runtime, example: --env-var-override 'foo=bar,bar=baz'",
 }
+
+var flagDisregardGitignore = &cli.BoolFlag{
+	Name:  "disregard-gitignore",
+	Usage: "[Optional] Disregard the .gitignore file when reading files in a directory",
+}
diff --git a/internal/cmd/stack/local_preview.go b/internal/cmd/stack/local_preview.go
@@ -66,7 +66,12 @@ func localPreview() cli.ActionFunc {
 
 		fp := filepath.Join(os.TempDir(), "spacectl", "local-workspace", fmt.Sprintf("%s.tar.gz", uploadMutation.UploadLocalWorkspace.ID))
 
-		matchFn, err := internal.GetIgnoreMatcherFn(ctx, packagePath)
+		ignoreFiles := []string{".terraformignore"}
+		if !cliCtx.IsSet(flagDisregardGitignore.Name) {
+			ignoreFiles = append(ignoreFiles, ".gitignore")
+		}
+
+		matchFn, err := internal.GetIgnoreMatcherFn(ctx, nil, ignoreFiles)
 		if err != nil {
 			return fmt.Errorf("couldn't analyze .gitignore and .terraformignore files")
 		}

diff --git a/internal/cmd/stack/stack.go b/internal/cmd/stack/stack.go
@@ -120,6 +120,7 @@ func Command() *cli.Command {
 					flagNoUpload,
 					flagOverrideEnvVars,
 					flagOverrideEnvVarsTF,
+					flagDisregardGitignore,
 				},
 				Action:    localPreview(),
 				Before:    authenticated.Ensure,

diff --git a/internal/local_preview.go b/internal/local_preview.go
@@ -49,25 +49,27 @@ func MoveToRepositoryRoot() error {
 // GetIgnoreMatcherFn creates an ignore-matcher for archiving purposes
 // This function respects gitignore and terraformignore, and
 // optionally if a projectRoot is provided it only include files from this root
-func GetIgnoreMatcherFn(ctx context.Context, projectRoot *string) (func(filePath string) bool, error) {
-	gitignore, err := ignore.CompileIgnoreFile(".gitignore")
-	if err != nil && !os.IsNotExist(err) {
-		return nil, fmt.Errorf("couldn't compile .gitignore file: %w", err)
-	}
-	terraformignore, err := ignore.CompileIgnoreFile(".terraformignore")
-	if err != nil && !os.IsNotExist(err) {
-		return nil, fmt.Errorf("couldn't compile .terraformignore file: %w", err)
+func GetIgnoreMatcherFn(ctx context.Context, projectRoot *string, ignoreFiles []string) (func(filePath string) bool, error) {
+	ignoreList := make([]*ignore.GitIgnore, 0)
+	for _, f := range ignoreFiles {
+		ignoreFile, err := ignore.CompileIgnoreFile(f)
+		if err != nil && !os.IsNotExist(err) {
+			return nil, fmt.Errorf("couldn't compile %s file: %w", f, err)
+		}
+
+		ignoreList = append(ignoreList, ignoreFile)
 	}
+
 	customignore := ignore.CompileIgnoreLines(".git", ".terraform")
 	return func(filePath string) bool {
 		if customignore.MatchesPath(filePath) {
 			return false
 		}
-		if gitignore != nil && gitignore.MatchesPath(filePath) {
-			return false
-		}
-		if terraformignore != nil && terraformignore.MatchesPath(filePath) {
-			return false
+
+		for _, v := range ignoreList {
+			if v != nil && v.MatchesPath(filePath) {
+				return false
+			}
 		}
 
 		if projectRoot != nil {