Merge branch 'main' into mwbrooks-maintainers-guide-deprecation

mwbrooks · web-flow · commit 5edb487d4c30 · 2025-05-05T12:54:01.000-07:00
diff --git a/.github/workflows/dependencies.yml b/.github/workflows/dependencies.yml
@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Gather credentials
         id: credentials
-        uses: actions/create-github-app-token@v2.0.3
+        uses: actions/create-github-app-token@v2.0.6
         with:
           app-id: ${{ secrets.GH_APP_ID_RELEASER }}
           private-key: ${{ secrets.GH_APP_PRIVATE_KEY_RELEASER }}
diff --git a/.github/workflows/sync-docs-from-cli-repo.yml b/.github/workflows/sync-docs-from-cli-repo.yml
@@ -22,7 +22,7 @@ jobs:
     steps:
       - name: Generate a GitHub token
         id: ghtoken
-        uses: actions/create-github-app-token@v2.0.3
+        uses: actions/create-github-app-token@v2.0.6
         with:
           app-id: ${{ secrets.GH_APP_ID_DOCS }}
           owner: slackapi
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -32,7 +32,7 @@ jobs:
         with:
           go-version: "1.24.2"
       - name: Lint
-        uses: golangci/golangci-lint-action@v7.0.0
+        uses: golangci/golangci-lint-action@v8.0.0
         with:
           version: latest
           args: --timeout=5m
diff --git a/.golangci.yml b/.golangci.yml
@@ -33,9 +33,6 @@ linters:
     staticcheck:
       checks:
         - all
-        - '-ST1005' # disable rule 'Incorrectly formatted error string'
-        - '-ST1006' # disable rule 'Poorly chosen receiver name'
-        - '-ST1008' # disable rule 'Function’s error value should be its last return value'
         - '-ST1023' # disable rule 'Redundant type in variable declaration'
         - '-QF1001' # disable rule 'Apply De Morgan’s law'
         - '-QF1012' # disable rule 'Use fmt.Fprintf instead of x.Write(fmt.Sprintf(...))'
diff --git a/cmd/auth/login.go b/cmd/auth/login.go
@@ -146,7 +146,7 @@ func printAuthSuccess(cmd *cobra.Command, IO iostreams.IOStreamer, credentialsPa
 
 // printAuthNextSteps suggests possible commands to run after logging in
 func printAuthNextSteps(ctx context.Context, clients *shared.ClientFactory) {
-	_, project := clients.SDKConfig.Exists()
+	project, _ := clients.SDKConfig.Exists()
 	if !project {
 		clients.IO.PrintInfo(ctx, false, style.Sectionf(style.TextSection{
 			Emoji: "bulb",
diff --git a/cmd/root.go b/cmd/root.go
@@ -406,7 +406,7 @@ func ExecuteContext(ctx context.Context, rootCmd *cobra.Command, clients *shared
 func cleanup(ctx context.Context, clients *shared.ClientFactory) {
 	clients.IO.PrintDebug(ctx, "Starting root command cleanup routine")
 	// clean up any json in project .slack folder if needed
-	if _, sdkConfigExists := clients.SDKConfig.Exists(); sdkConfigExists {
+	if sdkConfigExists, _ := clients.SDKConfig.Exists(); sdkConfigExists {
 		clients.AppClient().CleanUp()
 	}
 }
diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -236,15 +236,15 @@ func Test_Aliases(t *testing.T) {
 	}
 	for name, tt := range tests {
 		t.Run(name, func(t *testing.T) {
-			err, output := testExecCmd(ctx, strings.Fields(tt.args))
+			output, err := testExecCmd(ctx, strings.Fields(tt.args))
 			require.NoError(t, err)
 			require.Contains(t, output, tt.expected)
 		})
 	}
 }
 
 // testExecCmd will execute the root cobra command with args and return the output
-func testExecCmd(ctx context.Context, args []string) (error, string) {
+func testExecCmd(ctx context.Context, args []string) (string, error) {
 	// Get command
 	cmd, clients := Init(ctx)
 
@@ -257,7 +257,7 @@ func testExecCmd(ctx context.Context, args []string) (error, string) {
 	cmd.SetArgs(args)
 	err := cmd.ExecuteContext(ctx)
 	if err != nil {
-		return err, ""
+		return "", err
 	}
-	return nil, clientsMock.GetCombinedOutput()
+	return clientsMock.GetCombinedOutput(), nil
 }
diff --git a/go.mod b/go.mod
@@ -24,7 +24,7 @@ require (
 	github.com/stretchr/testify v1.10.0
 	github.com/uber/jaeger-client-go v2.30.0+incompatible
 	golang.org/x/mod v0.24.0
-	golang.org/x/sys v0.32.0
+	golang.org/x/sys v0.33.0
 	golang.org/x/text v0.24.0
 	gopkg.in/yaml.v2 v2.4.0
 )
diff --git a/go.sum b/go.sum
@@ -206,8 +206,8 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
-golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
+golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.31.0 h1:erwDkOK1Msy6offm1mOgvspSkslFnIGsFnxOKoufg3o=
diff --git a/internal/api/client.go b/internal/api/client.go
@@ -294,7 +294,7 @@ func (c *Client) DoWithRetry(ctx context.Context, request *http.Request, span op
 	span.SetTag("status_code", r.StatusCode)
 
 	if r.StatusCode != http.StatusOK {
-		return nil, errors.WithStack(fmt.Errorf("Slack API unexpected status code %d returned from url %s", r.StatusCode, sURL))
+		return nil, errors.WithStack(fmt.Errorf("unexpected status code %d returned from url %s", r.StatusCode, sURL))
 	}
 
 	var bytes []byte
diff --git a/internal/auth/auth.go b/internal/auth/auth.go
@@ -374,7 +374,7 @@ func (c *Client) SetAuth(ctx context.Context, auth types.SlackAuth) (types.Slack
 
 	allAuths, err := c.auths(ctx)
 	if err != nil {
-		return types.SlackAuth{}, "", fmt.Errorf("Failed to fetch user authorizations %s", err)
+		return types.SlackAuth{}, "", fmt.Errorf("failed to fetch user authorizations %s", err)
 	}
 	allAuths[auth.TeamID] = auth
 
diff --git a/internal/cmdutil/project.go b/internal/cmdutil/project.go
@@ -53,7 +53,7 @@ func IsSlackHostedProject(ctx context.Context, clients *shared.ClientFactory) er
 
 // IsValidProjectDirectory verifies that a command is run in a valid project directory and returns nil, otherwise returns an error
 func IsValidProjectDirectory(clients *shared.ClientFactory) error {
-	if err, _ := clients.SDKConfig.Exists(); err != nil {
+	if _, err := clients.SDKConfig.Exists(); err != nil {
 		return slackerror.New(slackerror.ErrInvalidAppDirectory)
 	}
 	return nil
diff --git a/internal/hooks/sdk_config.go b/internal/hooks/sdk_config.go
@@ -46,11 +46,11 @@ type SDKCLIConfig struct {
 }
 
 // Exists returns true when the SDKCLIConfig was successfully loaded, otherwise false with an error
-func (s *SDKCLIConfig) Exists() (error, bool) {
+func (s *SDKCLIConfig) Exists() (bool, error) {
 	if strings.TrimSpace(s.WorkingDirectory) == "" {
-		return slackerror.New(slackerror.ErrInvalidSlackProjectDirectory), false
+		return false, slackerror.New(slackerror.ErrInvalidSlackProjectDirectory)
 	}
-	return nil, true
+	return true, nil
 }
 
 type ProtocolVersions []Protocol
diff --git a/internal/hooks/sdk_config_test.go b/internal/hooks/sdk_config_test.go
@@ -40,7 +40,7 @@ func Test_SDKCLIConfig_Exists(t *testing.T) {
 	}
 	for name, tt := range tests {
 		t.Run(name, func(t *testing.T) {
-			err, exists := tt.sdkCLIConfig.Exists()
+			exists, err := tt.sdkCLIConfig.Exists()
 			require.Equal(t, tt.expectedError, err)
 			require.Equal(t, tt.exists, exists)
 		})
diff --git a/internal/hooks/shell.go b/internal/hooks/shell.go
@@ -40,7 +40,7 @@ type ShellCommand interface {
 type ShellExec struct{}
 
 // command sets arguments for the shell supported by the current operating system
-func (_ ShellExec) command(name string, arg ...string) *exec.Cmd {
+func (ShellExec) command(name string, arg ...string) *exec.Cmd {
 	script := fmt.Sprintf("%s %s", name, strings.Join(arg, " "))
 	switch {
 	case runtime.GOOS == "windows":
diff --git a/internal/pkg/create/create.go b/internal/pkg/create/create.go
@@ -169,7 +169,7 @@ func getAppDirName(appName string) (string, error) {
 
 	// name cannot be a reserved word
 	if goutils.Contains(reserved, appName, false) {
-		return "", fmt.Errorf("The app name you entered is reserved. Please try a different name.")
+		return "", fmt.Errorf("the app name you entered is reserved")
 	}
 	return appName, nil
 }
diff --git a/internal/pkg/platform/localserver.go b/internal/pkg/platform/localserver.go
@@ -428,7 +428,7 @@ type SocketEvent struct {
 func sendWebSocketMessage(c WebSocketConnection, linkResponse *LinkResponse) error {
 	// Validate the response
 	if linkResponse == nil {
-		return slackerror.Wrap(fmt.Errorf("Websocket response message cannot be empty"), slackerror.ErrSocketConnection)
+		return slackerror.Wrap(fmt.Errorf("websocket response message cannot be empty"), slackerror.ErrSocketConnection)
 	}
 
 	// Prepare response for websocket
diff --git a/internal/style/template.go b/internal/style/template.go
@@ -111,7 +111,7 @@ func getTemplateFuncs() template.FuncMap {
 func PrintTemplate(w io.Writer, tmpl string, data any) (err error) {
 	defer func() {
 		if r := recover(); r != nil {
-			err = fmt.Errorf("Failed to create the template! %+v", r)
+			err = fmt.Errorf("failed to create the template: %+v", r)
 		}
 	}()
 	t := template.New("template")
diff --git a/internal/update/cli_metadata.go b/internal/update/cli_metadata.go
@@ -98,7 +98,7 @@ func (md *Metadata) httpClientRequest(method string, host string, data interface
 	}
 
 	if res.StatusCode != http.StatusOK {
-		return errors.WithStack(fmt.Errorf("Slack CLI metadata responded with an unexpected status code %d from url %s", res.StatusCode, host))
+		return errors.WithStack(fmt.Errorf("CLI metadata responded with an unexpected status code %d from url %s", res.StatusCode, host))
 	}
 
 	var bytes []byte

Original file line number	Diff line number	Diff line change
`@@ -406,7 +406,7 @@ func ExecuteContext(ctx context.Context, rootCmd cobra.Command, clients shared`
`406`	`406`	`func cleanup(ctx context.Context, clients *shared.ClientFactory) {`
`407`	`407`	`clients.IO.PrintDebug(ctx, "Starting root command cleanup routine")`
`408`	`408`	`// clean up any json in project .slack folder if needed`
`409`		`- if _, sdkConfigExists := clients.SDKConfig.Exists(); sdkConfigExists {`
	`409`	`+ if sdkConfigExists, _ := clients.SDKConfig.Exists(); sdkConfigExists {`
`410`	`410`	`clients.AppClient().CleanUp()`
`411`	`411`	`}`
`412`	`412`	`}`
Original file line number	Diff line number	Diff line change
`@@ -236,15 +236,15 @@ func Test_Aliases(t *testing.T) {`
`236`	`236`	`}`
`237`	`237`	`for name, tt := range tests {`
`238`	`238`	`t.Run(name, func(t *testing.T) {`
`239`		`- err, output := testExecCmd(ctx, strings.Fields(tt.args))`
	`239`	`+ output, err := testExecCmd(ctx, strings.Fields(tt.args))`
`240`	`240`	`require.NoError(t, err)`
`241`	`241`	`require.Contains(t, output, tt.expected)`
`242`	`242`	`})`
`243`	`243`	`}`
`244`	`244`	`}`
`245`	`245`
`246`	`246`	`// testExecCmd will execute the root cobra command with args and return the output`
`247`		`-func testExecCmd(ctx context.Context, args []string) (error, string) {`
	`247`	`+func testExecCmd(ctx context.Context, args []string) (string, error) {`
`248`	`248`	`// Get command`
`249`	`249`	`cmd, clients := Init(ctx)`
`250`	`250`
`@@ -257,7 +257,7 @@ func testExecCmd(ctx context.Context, args []string) (error, string) {`
`257`	`257`	`cmd.SetArgs(args)`
`258`	`258`	`err := cmd.ExecuteContext(ctx)`
`259`	`259`	`if err != nil {`
`260`		`- return err, ""`
	`260`	`+ return "", err`
`261`	`261`	`}`
`262`		`- return nil, clientsMock.GetCombinedOutput()`
	`262`	`+ return clientsMock.GetCombinedOutput(), nil`
`263`	`263`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ require (`
`24`	`24`	`github.com/stretchr/testify v1.10.0`
`25`	`25`	`github.com/uber/jaeger-client-go v2.30.0+incompatible`
`26`	`26`	`golang.org/x/mod v0.24.0`
`27`		`- golang.org/x/sys v0.32.0`
	`27`	`+ golang.org/x/sys v0.33.0`
`28`	`28`	`golang.org/x/text v0.24.0`
`29`	`29`	`gopkg.in/yaml.v2 v2.4.0`
`30`	`30`	`)`
Original file line number	Diff line number	Diff line change
`@@ -294,7 +294,7 @@ func (c Client) DoWithRetry(ctx context.Context, request http.Request, span op`
`294`	`294`	`span.SetTag("status_code", r.StatusCode)`
`295`	`295`
`296`	`296`	`if r.StatusCode != http.StatusOK {`
`297`		`- return nil, errors.WithStack(fmt.Errorf("Slack API unexpected status code %d returned from url %s", r.StatusCode, sURL))`
	`297`	`+ return nil, errors.WithStack(fmt.Errorf("unexpected status code %d returned from url %s", r.StatusCode, sURL))`
`298`	`298`	`}`
`299`	`299`
`300`	`300`	`var bytes []byte`