chore: Golangci config update, clean repo, remove changelog (#101)

* chore: cleanup golangci output in github actions

* add new golangci config

* clean repo

* remove changelog

.golangci.yml

@@ -28,38 +28,27 @@ linters-settings:
 
   # https://github.com/ultraware/funlen
   funlen:
-    lines: 100
-    statements: 50
+    # accounting for comments
+    lines: 160
+    statements: 70
 
-  # https://github.com/golang/lint
-  golint:
-    min-confidence: 0
-
-  # https://github.com/tommy-muehle/go-mnd
-  gomnd:
-    settings:
-      mnd:
-        # don't include the "operation" and "assign"
-        checks: argument,case,condition,return
-
-  # https://github.com/walle/lll
-  lll:
-    line-length: 100
-
-  # https://github.com/mdempsky/maligned
-  maligned:
-    suggest-new: true
+  # https://github.com/denis-tingaikin/go-header
+  goheader:
+    template: |-
+      Copyright (c) {{ YEAR }} Target Brands, Inc. All rights reserved.
+      
+      Use of this source code is governed by the LICENSE file in this repository.
 
   # https://github.com/client9/misspell
   misspell:
     locale: US
 
   # https://github.com/golangci/golangci-lint/blob/master/pkg/golinters/nolintlint
   nolintlint:
-    allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
-    allow-unused: false # report any unused nolint directives
-    require-explanation: false # don't require an explanation for nolint directives
-    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+    allow-leading-space: true     # allow non-"machine-readable" format (ie. with leading space) 
+    allow-unused: false           # allow nolint directives that don't address a linting issue
+    require-explanation: true     # require an explanation for nolint directives
+    require-specific: true        # require nolint directives to be specific about which linter is being skipped
 
 # This section provides the configuration for which linters
 # golangci will execute. Several of them were disabled by
@@ -70,58 +59,91 @@ linters:
 
   # enable a specific set of linters to run
   enable:
-    - bodyclose
-    - deadcode # enabled by default
-    - dupl
-    - errcheck # enabled by default
-    - funlen
-    - goconst
-    - gocyclo
-    - godot
-    - gofmt
-    - goimports
-    - golint
-    - gomnd
-    - goprintffuncname
-    - gosec
-    - gosimple # enabled by default
-    - govet # enabled by default
-    - ineffassign # enabled by default
-    - lll
-    - maligned
-    - misspell
-    - nakedret
-    - nolintlint
-    - staticcheck # enabled by default
-    - structcheck # enabled by default
-    - stylecheck
-    - typecheck # enabled by default
-    - unconvert
-    - unparam
-    - unused # enabled by default
-    - varcheck # enabled by default
-    - whitespace
-
+    - bidichk             # checks for dangerous unicode character sequences
+    - bodyclose           # checks whether HTTP response body is closed successfully
+    - contextcheck        # check the function whether use a non-inherited context
+    - deadcode            # finds unused code
+    - dupl                # code clone detection
+    - errcheck            # checks for unchecked errors
+    - errorlint           # find misuses of errors
+    - exportloopref       # check for exported loop vars
+    - funlen              # detects long functions
+    - goconst             # finds repeated strings that could be replaced by a constant
+    - gocyclo             # computes and checks the cyclomatic complexity of functions
+    - godot               # checks if comments end in a period
+    - gofmt               # checks whether code was gofmt-ed
+    - goheader            # checks is file header matches to pattern
+    - goimports           # fixes imports and formats code in same style as gofmt
+    - gomoddirectives     # manage the use of 'replace', 'retract', and 'excludes' directives in go.mod
+    - goprintffuncname    # checks that printf-like functions are named with f at the end
+    - gosec               # inspects code for security problems
+    - gosimple            # linter that specializes in simplifying a code
+    - govet               # reports suspicious constructs, ex. Printf calls whose arguments don't align with the format string
+    - ineffassign         # detects when assignments to existing variables aren't used
+    - makezero            # finds slice declarations with non-zero initial length
+    - misspell            # finds commonly misspelled English words in comments
+    - nakedret            # finds naked returns in functions greater than a specified function length
+    - nilerr              # finds the code that returns nil even if it checks that the error is not nil
+    - noctx               # noctx finds sending http request without context.Context
+    - nolintlint          # reports ill-formed or insufficient nolint directives
+    - revive              # linter for go
+    - staticcheck         # applies static analysis checks, go vet on steroids
+    - structcheck         # finds unused struct fields
+    - stylecheck          # replacement for golint
+    - tenv                # analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
+    - typecheck           # parses and type-checks go code, like the front-end of a go compiler
+    - unconvert           # remove unnecessary type conversions
+    - unparam             # reports unused function parameters
+    - unused              # checks for unused constants, variables, functions and types
+    - varcheck            # finds unused global variables and constants
+    - whitespace          # detects leading and trailing whitespace
+    - wsl                 # forces code to use empty lines
+
   # static list of linters we know golangci can run but we've
   # chosen to leave disabled for now
-  # - asciicheck
-  # - depguard
-  # - dogsled
-  # - exhaustive
-  # - gochecknoinits
-  # - gochecknoglobals
-  # - gocognit
-  # - gocritic
-  # - godox
-  # - goerr113
-  # - interfacer
-  # - nestif
-  # - noctx
-  # - prealloc
-  # - rowserrcheck
-  # - scopelint
-  # - testpackage
-  # - wsl
+  # - asciicheck          - non-critical
+  # - cyclop              - unused complexity metric
+  # - depguard            - unused
+  # - dogsled             - blanks allowed
+  # - durationcheck       - unused
+  # - errname             - unused
+  # - exhaustive          - unused
+  # - exhaustivestruct    - style preference
+  # - forbidigo           - unused
+  # - forcetypeassert     - unused
+  # - gci                 - use goimports
+  # - gochecknoinits      - unused
+  # - gochecknoglobals    - global variables allowed
+  # - gocognit            - unused complexity metric 
+  # - gocritic            - style preference
+  # - godox               - to be used in the future
+  # - goerr113            - to be used in the future
+  # - golint              - archived, replaced with revive
+  # - gofumpt             - use gofmt
+  # - gomnd               - get too many false-positives
+  # - gomodguard          - unused
+  # - ifshort             - use both styles
+  # - ireturn             - allow interfaces to be returned
+  # - importas            - want flexibility with naming
+  # - lll                 - not too concerned about line length 
+  # - interfacer          - archived
+  # - nestif              - non-critical
+  # - nilnil              - style preference
+  # - nlreturn            - style preference
+  # - maligned            - archived, replaced with govet 'fieldalignment'
+  # - paralleltest        - false-positives
+  # - prealloc            - don't use
+  # - predeclared         - unused
+  # - promlinter          - style preference 
+  # - rowserrcheck        - unused
+  # - scopelint           - deprecated - replaced with exportloopref
+  # - sqlclosecheck       - unused
+  # - tagliatelle         - use a mix of variable naming
+  # - testpackage         - don't use this style of testing
+  # - thelper             - false-positives
+  # - varnamelen          - unused
+  # - wastedassign        - duplicate functionality
+  # - wrapcheck           - style preference
 
 # This section provides the configuration for how golangci
 # will report the issues it finds.
@@ -131,7 +153,7 @@ issues:
     # prevent linters from running on *_test.go files
     - path: _test\.go
       linters:
+        - dupl
         - funlen
         - goconst
         - gocyclo
-        - gomnd

cmd/vela-kubernetes/config.go

@@ -49,7 +49,6 @@ func (c *Config) Validate() error {
 	return nil
 }
 
-// nolint: gomnd // ignore magic number
 // Write creates a .kube/config file in the home directory of the current user.
 func (c *Config) Write() error {
 	logrus.Trace("writing Kubernetes configuration file")

cmd/vela-kubernetes/kubectl.go

@@ -54,7 +54,6 @@ func install(customVer, defaultVer string) error {
 
 	logrus.Debugf("changing ownership of file: %s", _kubectl)
 
-	// nolint: gomnd // ignore magic number
 	// ensure the kubectl binary is executable
 	err = a.Chmod(_kubectl, 0700)
 	if err != nil {

cmd/vela-kubernetes/main.go

@@ -18,7 +18,6 @@ import (
 	_ "github.com/joho/godotenv/autoload"
 )
 
-// nolint: funlen // ignore function length due to comments and flags
 func main() {
 	// capture application version information
 	v := version.New()

cmd/vela-kubernetes/patch.go

@@ -167,15 +167,15 @@ func (p *Patch) Validate() error {
 	// serialize provided containers into expected type
 	err := p.Unmarshal()
 	if err != nil {
-		return fmt.Errorf("unable to unmarshal patch containers: %v", err)
+		return fmt.Errorf("unable to unmarshal patch containers: %w", err)
 	}
 
 	// iterate through all containers
 	for _, container := range p.Containers {
 		// verify the container is valid
 		err := container.Validate()
 		if err != nil {
-			return fmt.Errorf("invalid patch container provided: %v", err)
+			return fmt.Errorf("invalid patch container provided: %w", err)
 		}
 	}
 

cmd/vela-kubernetes/plugin.go

@@ -58,7 +58,7 @@ func (p *Plugin) Exec() error {
 		return p.Status.Exec(p.Config)
 	default:
 		return fmt.Errorf(
-			"%s: %s (Valid actions: %s, %s, %s)",
+			"%w: %s (Valid actions: %s, %s, %s)",
 			ErrInvalidAction,
 			p.Config.Action,
 			applyAction,
@@ -91,7 +91,7 @@ func (p *Plugin) Validate() error {
 		return p.Status.Validate()
 	default:
 		return fmt.Errorf(
-			"%s: %s (Valid actions: %s, %s, %s)",
+			"%w: %s (Valid actions: %s, %s, %s)",
 			ErrInvalidAction,
 			p.Config.Action,
 			applyAction,

version/version.go

@@ -36,15 +36,15 @@ var (
 func New() *version.Version {
 	// check if a semantic tag was provided
 	if len(Tag) == 0 {
-		logrus.Warningf("no semantic tag provided - defaulting to v0.0.0")
+		logrus.Warning("no semantic tag provided - defaulting to v0.0.0")
 
 		// set a fallback default for the tag
 		Tag = "v0.0.0"
 	}
 
 	v, err := semver.NewVersion(Tag)
 	if err != nil {
-		fmt.Println(fmt.Errorf("unable to parse semantic version for %s: %v", Tag, err))
+		fmt.Println(fmt.Errorf("unable to parse semantic version for %s: %w", Tag, err))
 	}
 
 	return &version.Version{