Add lock Swift packges input

Author: lpusok

main.go

@@ -103,6 +103,8 @@ func createRunOptions(config step.Config) step.RunOpts {
 		XcodeMajorVersion: config.XcodeMajorVersion,
 		ArtifactName:      config.ArtifactName,
 
+		ShouldLockSwiftPackages: config.ShouldLockSwiftPackages,
+
 		CodesignManager: config.CodesignManager,
 
 		PerformCleanAction:          config.PerformCleanAction,

step.yml

@@ -115,6 +115,24 @@ inputs:
 
       The input value sets xcodebuild's `-configuration` option.
 
+- lock_swift_packages: "yes"
+  opts:
+    category: xcodebuild configuration
+    title: Disable Swift Package Manager automatic resolution
+    summary: If this input is set, the Step will disable Swift Package Manager automatic resolution.
+    description: |-
+      If this input is set, the Step will disable Swift Package Manager automatic resolution.
+
+      When enabled, runs the following:
+      ```
+      defaults write com.apple.dt.Xcode IDEPackageOnlyUseVersionsFromResolvedFile  -bool YES
+      defaults write com.apple.dt.Xcode IDEDisableAutomaticPackageResolution  -bool YES
+      ```
+    value_options:
+    - "yes"
+    - "no"
+    is_required: true
+
 - xcconfig_content: COMPILER_INDEX_STORE_ENABLE = NO
   opts:
     category: xcodebuild configuration

step/step.go

@@ -76,10 +76,11 @@ type Inputs struct {
 	ExportMethod string `env:"distribution_method,opt[app-store,ad-hoc,enterprise,development]"`
 
 	// xcodebuild configuration
-	Configuration      string `env:"configuration"`
-	XcconfigContent    string `env:"xcconfig_content"`
-	PerformCleanAction bool   `env:"perform_clean_action,opt[yes,no]"`
-	XcodebuildOptions  string `env:"xcodebuild_options"`
+	Configuration           string `env:"configuration"`
+	ShouldLockSwiftPackages bool   `env:"lock_swift_packages,opt[yes,no]"`
+	XcconfigContent         string `env:"xcconfig_content"`
+	PerformCleanAction      bool   `env:"perform_clean_action,opt[yes,no]"`
+	XcodebuildOptions       string `env:"xcodebuild_options"`
 
 	// xcodebuild log formatting
 	LogFormatter string `env:"log_formatter,opt[xcbeautify,xcodebuild,xcpretty]"`
@@ -319,6 +320,8 @@ type RunOpts struct {
 	XcodeMajorVersion int
 	ArtifactName      string
 
+	ShouldLockSwiftPackages bool
+
 	// Code signing, nil if automatic code signing is "off"
 	CodesignManager *codesign.Manager
 
@@ -361,6 +364,13 @@ func (s XcodebuildArchiver) Run(opts RunOpts) (RunResult, error) {
 	s.logger.Println()
 
 	if opts.XcodeMajorVersion >= 11 {
+		if opts.ShouldLockSwiftPackages {
+			s.logger.Infof("Swift package dependencies are locked, disabling automatic updates")
+			if err := lockSwiftPackages(s.logger, s.cmdFactory); err != nil {
+				return out, fmt.Errorf("failed to lock swift packages: %w", err)
+			}
+		}
+
 		s.logger.Infof("Running resolve Swift package dependencies")
 		// Resolve Swift package dependencies, so running -showBuildSettings later is faster later
 		// Specifying a scheme is required for workspaces

step/utils.go

@@ -3,12 +3,14 @@ package step
 import (
 	"bufio"
 	"fmt"
+	"os"
 	"regexp"
 	"strings"
 
 	"github.com/bitrise-io/go-utils/colorstring"
 	"github.com/bitrise-io/go-utils/sliceutil"
 	"github.com/bitrise-io/go-utils/stringutil"
+	"github.com/bitrise-io/go-utils/v2/command"
 	"github.com/bitrise-io/go-utils/v2/log"
 	"github.com/bitrise-io/go-xcode/exportoptions"
 )
@@ -91,3 +93,26 @@ func findIDEDistrubutionLogsPath(output string, logger log.Logger) (string, erro
 
 	return "", nil
 }
+
+func lockSwiftPackages(logger log.Logger, cmdFactory command.Factory) error {
+	// defaults write com.apple.dt.Xcode IDEPackageOnlyUseVersionsFromResolvedFile  -bool YES
+	// defaults write com.apple.dt.Xcode IDEDisableAutomaticPackageResolution  -bool YES
+
+	cmdOpts := &command.Opts{
+		Stdout: os.Stdout,
+		Stderr: os.Stderr,
+	}
+	deafultsCommands := []command.Command{
+		cmdFactory.Create("defaults", []string{"write", "com.apple.dt.Xcode", "IDEPackageOnlyUseVersionsFromResolvedFile", "-bool", "YES"}, cmdOpts),
+		cmdFactory.Create("defaults", []string{"write", "com.apple.dt.Xcode", "IDEDisableAutomaticPackageResolution", "-bool", "YES"}, cmdOpts),
+	}
+
+	for _, cmd := range deafultsCommands {
+		logger.Printf("$ %s", cmd.PrintableCommandArgs())
+		if err := cmd.Run(); err != nil {
+			return fmt.Errorf("Locking Swift pacakges failed: %w", err)
+		}
+	}
+
+	return nil
+}