chore(lint): add struct tag align rule

.golangci.yml

@@ -47,6 +47,12 @@ linters-settings:
       - dot
       - prefix(github.com/go-vela)
 
+  # https://golangci-lint.run/usage/linters/#tagalign
+  # ensure struct tags are aligned
+  # will auto fix with `make lintfix`  
+  tagalign:
+    sort: false
+
   # https://github.com/denis-tingaikin/go-header
   goheader:
     template: |-
@@ -100,6 +106,7 @@ linters:
     - revive # linter for go
     - staticcheck # applies static analysis checks, go vet on steroids
     - stylecheck # replacement for golint
+    - tagalign # finds maligned struct tags
     - 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

api/types/secret.go

@@ -22,7 +22,7 @@ type Secret struct {
 	Value             *string   `json:"value,omitempty"`
 	Type              *string   `json:"type,omitempty"`
 	Images            *[]string `json:"images,omitempty"`
-	AllowEvents       *Events   `json:"allow_events,omitempty" yaml:"allow_events"`
+	AllowEvents       *Events   `json:"allow_events,omitempty"       yaml:"allow_events"`
 	AllowCommand      *bool     `json:"allow_command,omitempty"`
 	AllowSubstitution *bool     `json:"allow_substitution,omitempty"`
 	CreatedAt         *int64    `json:"created_at,omitempty"`

api/types/settings/compiler.go

@@ -5,8 +5,8 @@ package settings
 import "fmt"
 
 type Compiler struct {
-	CloneImage        *string `json:"clone_image,omitempty" yaml:"clone_image,omitempty"`
-	TemplateDepth     *int    `json:"template_depth,omitempty" yaml:"template_depth,omitempty"`
+	CloneImage        *string `json:"clone_image,omitempty"         yaml:"clone_image,omitempty"`
+	TemplateDepth     *int    `json:"template_depth,omitempty"      yaml:"template_depth,omitempty"`
 	StarlarkExecLimit *uint64 `json:"starlark_exec_limit,omitempty" yaml:"starlark_exec_limit,omitempty"`
 }
 

api/types/settings/platform.go

@@ -13,13 +13,13 @@ import (
 // swagger:model Platform
 type Platform struct {
 	ID                *int64 `json:"id"`
-	*Compiler         `json:"compiler,omitempty" yaml:"compiler,omitempty"`
-	*Queue            `json:"queue,omitempty" yaml:"queue,omitempty"`
-	RepoAllowlist     *[]string `json:"repo_allowlist,omitempty" yaml:"repo_allowlist,omitempty"`
+	*Compiler         `json:"compiler,omitempty"           yaml:"compiler,omitempty"`
+	*Queue            `json:"queue,omitempty"              yaml:"queue,omitempty"`
+	RepoAllowlist     *[]string `json:"repo_allowlist,omitempty"     yaml:"repo_allowlist,omitempty"`
 	ScheduleAllowlist *[]string `json:"schedule_allowlist,omitempty" yaml:"schedule_allowlist,omitempty"`
-	CreatedAt         *int64    `json:"created_at,omitempty" yaml:"created_at,omitempty"`
-	UpdatedAt         *int64    `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
-	UpdatedBy         *string   `json:"updated_by,omitempty" yaml:"updated_by,omitempty"`
+	CreatedAt         *int64    `json:"created_at,omitempty"         yaml:"created_at,omitempty"`
+	UpdatedAt         *int64    `json:"updated_at,omitempty"         yaml:"updated_at,omitempty"`
+	UpdatedBy         *string   `json:"updated_by,omitempty"         yaml:"updated_by,omitempty"`
 }
 
 // FromCLIContext returns a new Platform record from a cli context.

compiler/types/pipeline/build.go

@@ -15,15 +15,15 @@ import (
 //
 // swagger:model PipelineBuild
 type Build struct {
-	ID          string             `json:"id,omitempty"       yaml:"id,omitempty"`
-	Version     string             `json:"version,omitempty"  yaml:"version,omitempty"`
-	Metadata    Metadata           `json:"metadata,omitempty" yaml:"metadata,omitempty"`
+	ID          string             `json:"id,omitempty"          yaml:"id,omitempty"`
+	Version     string             `json:"version,omitempty"     yaml:"version,omitempty"`
+	Metadata    Metadata           `json:"metadata,omitempty"    yaml:"metadata,omitempty"`
 	Environment raw.StringSliceMap `json:"environment,omitempty" yaml:"environment,omitempty"`
-	Worker      Worker             `json:"worker,omitempty"   yaml:"worker,omitempty"`
-	Secrets     SecretSlice        `json:"secrets,omitempty"  yaml:"secrets,omitempty"`
-	Services    ContainerSlice     `json:"services,omitempty" yaml:"services,omitempty"`
-	Stages      StageSlice         `json:"stages,omitempty"   yaml:"stages,omitempty"`
-	Steps       ContainerSlice     `json:"steps,omitempty"    yaml:"steps,omitempty"`
+	Worker      Worker             `json:"worker,omitempty"      yaml:"worker,omitempty"`
+	Secrets     SecretSlice        `json:"secrets,omitempty"     yaml:"secrets,omitempty"`
+	Services    ContainerSlice     `json:"services,omitempty"    yaml:"services,omitempty"`
+	Stages      StageSlice         `json:"stages,omitempty"      yaml:"stages,omitempty"`
+	Steps       ContainerSlice     `json:"steps,omitempty"       yaml:"steps,omitempty"`
 }
 
 // Purge removes the steps, in every stage, that contain a ruleset

compiler/types/pipeline/container.go

@@ -51,8 +51,8 @@ type (
 		Ulimits     UlimitSlice       `json:"ulimits,omitempty"     yaml:"ulimits,omitempty"`
 		Volumes     VolumeSlice       `json:"volumes,omitempty"     yaml:"volumes,omitempty"`
 		User        string            `json:"user,omitempty"        yaml:"user,omitempty"`
-		ReportAs    string            `json:"report_as,omitempty" yaml:"report_as,omitempty"`
-		IDRequest   string            `json:"id_request,omitempty" yaml:"id_request,omitempty"`
+		ReportAs    string            `json:"report_as,omitempty"   yaml:"report_as,omitempty"`
+		IDRequest   string            `json:"id_request,omitempty"  yaml:"id_request,omitempty"`
 	}
 )
 

compiler/types/pipeline/metadata.go

@@ -6,15 +6,15 @@ package pipeline
 //
 // swagger:model PipelineMetadata
 type Metadata struct {
-	Template    bool           `json:"template,omitempty" yaml:"template,omitempty"`
-	Clone       bool           `json:"clone,omitempty" yaml:"clone,omitempty"`
+	Template    bool           `json:"template,omitempty"    yaml:"template,omitempty"`
+	Clone       bool           `json:"clone,omitempty"       yaml:"clone,omitempty"`
 	Environment []string       `json:"environment,omitempty" yaml:"environment,omitempty"`
 	AutoCancel  *CancelOptions `json:"auto_cancel,omitempty" yaml:"auto_cancel,omitempty"`
 }
 
 // CancelOptions is the pipeline representation of the auto_cancel block for a pipeline.
 type CancelOptions struct {
-	Running       bool `yaml:"running,omitempty" json:"running,omitempty"`
-	Pending       bool `yaml:"pending,omitempty" json:"pending,omitempty"`
+	Running       bool `yaml:"running,omitempty"        json:"running,omitempty"`
+	Pending       bool `yaml:"pending,omitempty"        json:"pending,omitempty"`
 	DefaultBranch bool `yaml:"default_branch,omitempty" json:"default_branch,omitempty"`
 }

compiler/types/yaml/build.go

@@ -9,15 +9,15 @@ import (
 
 // Build is the yaml representation of a build for a pipeline.
 type Build struct {
-	Version     string             `yaml:"version,omitempty"   json:"version,omitempty"  jsonschema:"required,minLength=1,description=Provide syntax version used to evaluate the pipeline.\nReference: https://go-vela.github.io/docs/reference/yaml/version/"`
-	Metadata    Metadata           `yaml:"metadata,omitempty"  json:"metadata,omitempty" jsonschema:"description=Pass extra information.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/"`
+	Version     string             `yaml:"version,omitempty"     json:"version,omitempty"     jsonschema:"required,minLength=1,description=Provide syntax version used to evaluate the pipeline.\nReference: https://go-vela.github.io/docs/reference/yaml/version/"`
+	Metadata    Metadata           `yaml:"metadata,omitempty"    json:"metadata,omitempty"    jsonschema:"description=Pass extra information.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/"`
 	Environment raw.StringSliceMap `yaml:"environment,omitempty" json:"environment,omitempty" jsonschema:"description=Provide global environment variables injected into the container environment.\nReference: https://go-vela.github.io/docs/reference/yaml/steps/#the-environment-key"`
-	Worker      Worker             `yaml:"worker,omitempty"    json:"worker,omitempty" jsonschema:"description=Limit the pipeline to certain types of workers.\nReference: https://go-vela.github.io/docs/reference/yaml/worker/"`
-	Secrets     SecretSlice        `yaml:"secrets,omitempty"   json:"secrets,omitempty" jsonschema:"description=Provide sensitive information.\nReference: https://go-vela.github.io/docs/reference/yaml/secrets/"`
-	Services    ServiceSlice       `yaml:"services,omitempty"  json:"services,omitempty" jsonschema:"description=Provide detached (headless) execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/services/"`
-	Stages      StageSlice         `yaml:"stages,omitempty"    json:"stages,omitempty" jsonschema:"oneof_required=stages,description=Provide parallel execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/stages/"`
-	Steps       StepSlice          `yaml:"steps,omitempty"     json:"steps,omitempty" jsonschema:"oneof_required=steps,description=Provide sequential execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/steps/"`
-	Templates   TemplateSlice      `yaml:"templates,omitempty" json:"templates,omitempty" jsonschema:"description=Provide the name of templates to expand.\nReference: https://go-vela.github.io/docs/reference/yaml/templates/"`
+	Worker      Worker             `yaml:"worker,omitempty"      json:"worker,omitempty"      jsonschema:"description=Limit the pipeline to certain types of workers.\nReference: https://go-vela.github.io/docs/reference/yaml/worker/"`
+	Secrets     SecretSlice        `yaml:"secrets,omitempty"     json:"secrets,omitempty"     jsonschema:"description=Provide sensitive information.\nReference: https://go-vela.github.io/docs/reference/yaml/secrets/"`
+	Services    ServiceSlice       `yaml:"services,omitempty"    json:"services,omitempty"    jsonschema:"description=Provide detached (headless) execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/services/"`
+	Stages      StageSlice         `yaml:"stages,omitempty"      json:"stages,omitempty"      jsonschema:"oneof_required=stages,description=Provide parallel execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/stages/"`
+	Steps       StepSlice          `yaml:"steps,omitempty"       json:"steps,omitempty"       jsonschema:"oneof_required=steps,description=Provide sequential execution instructions.\nReference: https://go-vela.github.io/docs/reference/yaml/steps/"`
+	Templates   TemplateSlice      `yaml:"templates,omitempty"   json:"templates,omitempty"   jsonschema:"description=Provide the name of templates to expand.\nReference: https://go-vela.github.io/docs/reference/yaml/templates/"`
 }
 
 // ToPipelineAPI converts the Build type to an API Pipeline type.

compiler/types/yaml/metadata.go

@@ -10,18 +10,18 @@ type (
 	// Metadata is the yaml representation of
 	// the metadata block for a pipeline.
 	Metadata struct {
-		Template     bool           `yaml:"template,omitempty" json:"template,omitempty" jsonschema:"description=Enables compiling the pipeline as a template.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-template-key"`
+		Template     bool           `yaml:"template,omitempty"      json:"template,omitempty"      jsonschema:"description=Enables compiling the pipeline as a template.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-template-key"`
 		RenderInline bool           `yaml:"render_inline,omitempty" json:"render_inline,omitempty" jsonschema:"description=Enables inline compiling for the pipeline templates.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-render-inline-key"`
-		Clone        *bool          `yaml:"clone,omitempty" json:"clone,omitempty" jsonschema:"default=true,description=Enables injecting the default clone process.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-clone-key"`
-		Environment  []string       `yaml:"environment,omitempty" json:"environment,omitempty" jsonschema:"description=Controls which containers processes can have global env injected.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-environment-key"`
-		AutoCancel   *CancelOptions `yaml:"auto_cancel,omitempty" json:"auto_cancel,omitempty" jsonschema:"description=Enables auto canceling of queued or running pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
+		Clone        *bool          `yaml:"clone,omitempty"         json:"clone,omitempty"         jsonschema:"default=true,description=Enables injecting the default clone process.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-clone-key"`
+		Environment  []string       `yaml:"environment,omitempty"   json:"environment,omitempty"   jsonschema:"description=Controls which containers processes can have global env injected.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-environment-key"`
+		AutoCancel   *CancelOptions `yaml:"auto_cancel,omitempty"   json:"auto_cancel,omitempty"   jsonschema:"description=Enables auto canceling of queued or running pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
 	}
 
 	// CancelOptions is the yaml representation of
 	// the auto_cancel block for a pipeline.
 	CancelOptions struct {
-		Running       *bool `yaml:"running,omitempty" json:"running,omitempty" jsonschema:"description=Enables auto canceling of running pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
-		Pending       *bool `yaml:"pending,omitempty" json:"pending,omitempty" jsonschema:"description=Enables auto canceling of queued pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
+		Running       *bool `yaml:"running,omitempty"        json:"running,omitempty"        jsonschema:"description=Enables auto canceling of running pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
+		Pending       *bool `yaml:"pending,omitempty"        json:"pending,omitempty"        jsonschema:"description=Enables auto canceling of queued pipelines that become stale due to new push.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
 		DefaultBranch *bool `yaml:"default_branch,omitempty" json:"default_branch,omitempty" jsonschema:"description=Enables auto canceling of queued or running pipelines that become stale due to new push to default branch.\nReference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key"`
 	}
 )