Upgrade golangci-lint and fix new lint warnings with Go 1.18 (#70)

* Upgrade golangci-lint

* Fix new lint warnings with Go 1.18

* Remove the golangci template.

This was only necessary when upgrading the Go version, which is now
automated.

* Fix go mod download conflicting with go mod tidy.

Run go mod tidy after go mod download to restore go.sum to the state we
should commit.

* Prepare changelog for 0.2.10.

Author: cmacknz

.github/workflows/golangci-lint.yml

@@ -26,24 +26,24 @@ jobs:
           GOOS: ${{ matrix.GOOS }}
         run: echo Go GOOS=$GOOS
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       # Uses Go version from the repository.
       - name: Read .go-version file
         id: goversion
         run: echo "::set-output name=version::$(cat .go-version)"
 
-      - uses: actions/setup-go@v2
+      - uses: actions/setup-go@v3
         with:
           go-version: "${{ steps.goversion.outputs.version }}"
 
       - name: golangci-lint
         env:
           GOOS: ${{ matrix.GOOS }}
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.45.2
+          version: v1.47.2
 
           # Give the job more time to execute.
           # Regarding `--whole-files`, the linter is supposed to support linting of changed a patch only but,

.golangci.yml

@@ -1,6 +1,3 @@
-# DO NOT EDIT!
-# This file is a rendered template, the source can be found in "./dev-tools/templates/.golangci.yml"
-#
 # options for analysis running
 run:
   # timeout for analysis, e.g. 30s, 5m, default is 1m

CHANGELOG.md

@@ -6,8 +6,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- Add option to `file.NewFileRotator` to allow setting file extension. #68
-
 ### Changed
 
 ### Deprecated
@@ -16,6 +14,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [0.2.10]
+
+### Added
+
+- Add option to `file.NewFileRotator` to allow setting file extension. #68
+
+### Changed
+
+- dev-tools: remove support for golanci-lint version templating, fix for notice target modifying go.sum. #70
+
+### Fixed
+
 - Fix filename logging in `file.NewFileRotator`. #68
 
 ## [0.2.9]

dev-tools/mage/go-version.go

@@ -21,72 +21,26 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"log"
 	"net/http"
 	"os"
 	"path/filepath"
-	"strings"
-	"text/template"
 
 	"github.com/magefile/mage/mg"
 	"github.com/magefile/mage/sh"
 )
 
 const (
-	linterInstallURL             = "https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh"
-	linterInstallFilename        = "./build/intall-golang-ci.sh"
-	linterBinaryFilename         = "./build/golangci-lint"
-	linterVersion                = "v1.45.2"
-	linterConfigFilename         = "./.golangci.yml"
-	linterConfigTemplateFilename = "./dev-tools/templates/.golangci.yml"
+	linterInstallURL      = "https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh"
+	linterInstallFilename = "./build/install-golang-ci.sh"
+	linterBinaryFilename  = "./build/golangci-lint"
+	linterVersion         = "v1.47.2"
+	linterConfigFilename  = "./.golangci.yml"
 )
 
 // Linter contains targets related to linting the Go code
 type Linter mg.Namespace
 
-// UpdateGoVersion updates the linter configuration with the new version of Go.
-func (Linter) UpdateGoVersion() error {
-	goVersionBytes, err := ioutil.ReadFile(goVersionFilename)
-	if err != nil {
-		return fmt.Errorf("failed to read the %q file: %w", goVersionFilename, err)
-	}
-	goVersion := strings.TrimSpace(string(goVersionBytes))
-	log.Printf("The Go version is %s\n", goVersion)
-
-	templateContext := struct{ GoVersion string }{GoVersion: goVersion}
-	template, err := template.ParseFiles(linterConfigTemplateFilename)
-	if err != nil {
-		return fmt.Errorf("failed to read the template file %q: %w", linterConfigTemplateFilename, err)
-	}
-
-	configFile, err := os.OpenFile(linterConfigFilename, os.O_TRUNC|os.O_CREATE|os.O_WRONLY, 0700)
-	if err != nil {
-		return fmt.Errorf("failed to create/replace the linter config %q: %w", linterConfigFilename, err)
-	}
-	defer configFile.Close()
-
-	warning := fmt.Sprintf("# DO NOT EDIT!\n# This file is a rendered template, the source can be found in %q\n#\n", linterConfigTemplateFilename)
-	_, err = configFile.WriteString(warning)
-	if err != nil {
-		return fmt.Errorf("failed to write into the linter config %q: %w", linterConfigFilename, err)
-	}
-
-	err = template.Execute(configFile, templateContext)
-	if err != nil {
-		return fmt.Errorf("failed to execute the template %q: %w", linterConfigTemplateFilename, err)
-	}
-
-	err = assertUnchanged(linterConfigFilename)
-	if err != nil {
-		log.Printf("Successfully updated the linter configuration %q to Go version %s, please commit the changes now", linterConfigFilename, goVersion)
-	} else {
-		log.Printf("The linter configuration %q is up to date, no changes made", linterConfigFilename)
-	}
-
-	return nil
-}
-
 // CheckConfig makes sure that the `.golangci.yml` does not have uncommitted changes
 func (Linter) CheckConfig() error {
 	err := assertUnchanged(linterConfigFilename)
@@ -100,18 +54,28 @@ func (Linter) CheckConfig() error {
 // using the official installation script downloaded from GitHub.
 // If the linter binary already exists does nothing.
 func (Linter) Install() error {
+	return install(false)
+}
+
+// ForceInstall force installs the linter regardless of whether it exists or not.
+// Useful primarily when the linter version should be updated.
+func (Linter) ForceInstall() error {
+	return install(true)
+}
+
+func install(force bool) error {
 	dirPath := filepath.Dir(linterBinaryFilename)
 	err := os.MkdirAll(dirPath, 0700)
 	if err != nil {
 		return fmt.Errorf("failed to create path %q: %w", dirPath, err)
 	}
 
 	_, err = os.Stat(linterBinaryFilename)
-	if err == nil {
+	if !force && err == nil {
 		log.Println("The linter has been already installed, skipping...")
 		return nil
 	}
-	if !errors.Is(err, os.ErrNotExist) {
+	if err != nil && !errors.Is(err, os.ErrNotExist) {
 		return fmt.Errorf("failed check if file %q exists: %w", linterBinaryFilename, err)
 	}
 

dev-tools/mage/linter.go

@@ -34,6 +34,11 @@ func GenerateNotice(overrides, rules, noticeTemplate string) error {
 		return fmt.Errorf("error while downloading dependencies: %w", err)
 	}
 
+	// Ensure the go.mod file is left unchanged after go mod download all runs.
+	// go mod download will modify go.sum in a way that conflicts with go mod tidy.
+	// https://github.com/golang/go/issues/43994#issuecomment-770053099
+	defer gotool.Mod.Tidy() //nolint:errcheck // No value in handling this error.
+
 	out, _ := gotool.ListDepsForNotice()
 	depsFile, _ := os.CreateTemp("", "depsout")
 	defer os.Remove(depsFile.Name())

dev-tools/mage/notice.go

@@ -206,7 +206,7 @@ func (c *Client) handleError(err error) error {
 		c.log.Debugf("handle error: %+v", err)
 
 		var nerr net.Error
-		if errors.As(err, &nerr) && !(nerr.Temporary() || nerr.Timeout()) {
+		if errors.As(err, &nerr) && !nerr.Timeout() {
 			_ = c.Close()
 		}
 	}

dev-tools/templates/.golangci.yml

@@ -75,7 +75,7 @@ func (p *ProxyHeaders) UnmarshalYAML(unmarshal func(interface{}) error) error {
 // URI returns conventional url.URL structure.
 func (p ProxyHeaders) Headers() http.Header {
 	var httpHeaders http.Header
-	if p != nil && len(p) > 0 {
+	if len(p) > 0 {
 		httpHeaders = http.Header{}
 		for k, v := range p {
 			httpHeaders.Add(k, v)