chore: deprecate types

go-vela · Oct 25, 2024 · 3701098 · 3701098
1 parent 7787735
commit 3701098
Show file tree

Hide file tree

Showing 69 changed files with 172 additions and 49 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -1,5 +1,8 @@
 # types
 
+> :warning: The types module is deprecated.
+> Please use the types located in [go-vela/server](https://github.com/go-vela/server)
+
 [![license](https://img.shields.io/crates/l/gl.svg)](../LICENSE)
 [![GoDoc](https://godoc.org/github.com/go-vela/types?status.svg)](https://godoc.org/github.com/go-vela/types)
 [![Go Report Card](https://goreportcard.com/badge/go-vela/types)](https://goreportcard.com/report/go-vela/types)

diff --git a/constants/doc.go b/constants/doc.go
@@ -2,7 +2,7 @@
 
 // Package constants provides the defined constant types for Vela.
 //
-// Usage:
+// Deprecated: all constants for Vela have been moved to github.com/go-vela/server/constants.
 //
-//	import "github.com/go-vela/types/constants"
+// This package is frozen.
 package constants
diff --git a/database/build.go b/database/build.go
@@ -30,6 +30,8 @@ const (
 )
 
 // Build is the database representation of a build for a pipeline.
+//
+// Deprecated: use Build from github.com/go-vela/server/database/types instead.
 type Build struct {
 	ID            sql.NullInt64      `sql:"id"`
 	RepoID        sql.NullInt64      `sql:"repo_id"`

diff --git a/database/build_executable.go b/database/build_executable.go
@@ -17,6 +17,8 @@ var (
 )
 
 // BuildExecutable is the database representation of a BuildExecutable.
+//
+// Deprecated: use BuildExecutable from github.com/go-vela/server/database/types instead.
 type BuildExecutable struct {
 	ID      sql.NullInt64 `sql:"id"`
 	BuildID sql.NullInt64 `sql:"build_id"`

diff --git a/database/build_queue.go b/database/build_queue.go
@@ -9,6 +9,8 @@ import (
 )
 
 // BuildQueue is the database representation of the builds in the queue.
+//
+// Deprecated: use QueueBuild from github.com/go-vela/server/database/types instead.
 type BuildQueue struct {
 	Status   sql.NullString `sql:"status"`
 	Number   sql.NullInt32  `sql:"number"`

diff --git a/database/deployment.go b/database/deployment.go
@@ -25,6 +25,8 @@ var (
 )
 
 // Deployment is the database representation of a deployment for a repo.
+//
+// Deprecated: use Deployment from github.com/go-vela/server/database/types instead.
 type Deployment struct {
 	ID          sql.NullInt64      `sql:"id"`
 	Number      sql.NullInt64      `sql:"number"`

diff --git a/database/doc.go b/database/doc.go
@@ -2,7 +2,7 @@
 
 // Package database provides the defined database types for Vela.
 //
-// Usage:
+// Deprecated: all database types for Vela have been moved to github.com/go-vela/server/database/types .
 //
-//	import "github.com/go-vela/types/database"
+// This package is frozen.
 package database
diff --git a/database/hook.go b/database/hook.go
@@ -28,6 +28,8 @@ var (
 )
 
 // Hook is the database representation of a webhook for a repo.
+//
+// Deprecated: use Hook from github.com/go-vela/server/database/types instead.
 type Hook struct {
 	ID          sql.NullInt64  `sql:"id"`
 	RepoID      sql.NullInt64  `sql:"repo_id"`

diff --git a/database/log.go b/database/log.go
@@ -24,6 +24,8 @@ var (
 )
 
 // Log is the database representation of a log for a step in a build.
+//
+// Deprecated: use Log from github.com/go-vela/server/database/types instead.
 type Log struct {
 	ID        sql.NullInt64 `sql:"id"`
 	BuildID   sql.NullInt64 `sql:"build_id"`

diff --git a/database/pipeline.go b/database/pipeline.go
@@ -32,6 +32,8 @@ var (
 )
 
 // Pipeline is the database representation of a pipeline.
+//
+// Deprecated: use Pipeline from github.com/go-vela/server/database/types instead.
 type Pipeline struct {
 	ID              sql.NullInt64  `sql:"id"`
 	RepoID          sql.NullInt64  `sql:"repo_id"`

diff --git a/database/repo.go b/database/repo.go
@@ -44,6 +44,8 @@ var (
 )
 
 // Repo is the database representation of a repo.
+//
+// Deprecated: use Repo from github.com/go-vela/server/database/types instead.
 type Repo struct {
 	ID           sql.NullInt64  `sql:"id"`
 	UserID       sql.NullInt64  `sql:"user_id"`

diff --git a/database/schedule.go b/database/schedule.go
@@ -26,6 +26,8 @@ var (
 )
 
 // Schedule is the database representation of a schedule for a repo.
+//
+// Deprecated: use Schedule from github.com/go-vela/server/database/types instead.
 type Schedule struct {
 	ID          sql.NullInt64  `sql:"id"`
 	RepoID      sql.NullInt64  `sql:"repo_id"`

diff --git a/database/secret.go b/database/secret.go
@@ -41,6 +41,8 @@ var (
 )
 
 // Secret is the database representation of a secret.
+//
+// Deprecated: use Secret from github.com/go-vela/server/database/types instead.
 type Secret struct {
 	ID                sql.NullInt64  `sql:"id"`
 	Org               sql.NullString `sql:"org"`

diff --git a/database/service.go b/database/service.go
@@ -32,6 +32,8 @@ var (
 )
 
 // Service is the database representation of a service in a build.
+//
+// Deprecated: use Service from github.com/go-vela/server/database/types instead.
 type Service struct {
 	ID           sql.NullInt64  `sql:"id"`
 	BuildID      sql.NullInt64  `sql:"build_id"`

diff --git a/database/step.go b/database/step.go
@@ -32,6 +32,8 @@ var (
 )
 
 // Step is the database representation of a step in a build.
+//
+// Deprecated: use Step from github.com/go-vela/server/database/types instead.
 type Step struct {
 	ID           sql.NullInt64  `sql:"id"`
 	BuildID      sql.NullInt64  `sql:"build_id"`

diff --git a/database/user.go b/database/user.go
@@ -41,6 +41,8 @@ var (
 )
 
 // User is the database representation of a user.
+//
+// Deprecated: use User from github.com/go-vela/server/database/types instead.
 type User struct {
 	ID           sql.NullInt64  `sql:"id"`
 	Name         sql.NullString `sql:"name"`

diff --git a/database/worker.go b/database/worker.go
@@ -27,6 +27,8 @@ var (
 )
 
 // Worker is the database representation of a worker.
+//
+// Deprecated: use Worker from github.com/go-vela/server/database/types instead.
 type Worker struct {
 	ID                  sql.NullInt64  `sql:"id"`
 	Hostname            sql.NullString `sql:"hostname"`

diff --git a/errors.go b/errors.go
@@ -6,7 +6,7 @@ import "fmt"
 
 // Error is the json error message from the server for a given http response.
 //
-// swagger:model Error
+// Deprecated: use Error from github.com/go-vela/server/api/types instead.
 type Error struct {
 	Message *string `json:"error"`
 }

diff --git a/item.go b/item.go
@@ -13,6 +13,8 @@ import (
 const ItemVersion uint64 = 2
 
 // Item is the queue representation of an item to publish to the queue.
+//
+// Deprecated: use Item from github.com/go-vela/server/queue/models instead.
 type Item struct {
 	Build *library.Build `json:"build"`
 	Repo  *library.Repo  `json:"repo"`

diff --git a/library/actions/comment.go b/library/actions/comment.go
@@ -6,6 +6,8 @@ import "github.com/go-vela/types/constants"
 
 // Comment is the library representation of the various actions associated
 // with the comment event webhook from the SCM.
+//
+// Deprecated: use Comment from github.com/go-vela/server/api/types/actions instead.
 type Comment struct {
 	Created *bool `json:"created"`
 	Edited  *bool `json:"edited"`

diff --git a/library/actions/deploy.go b/library/actions/deploy.go
@@ -7,6 +7,8 @@ import "github.com/go-vela/types/constants"
 
 // Deploy is the library representation of the various actions associated
 // with the deploy event webhook from the SCM.
+//
+// Deprecated: use Deploy from github.com/go-vela/server/api/types/actions instead.
 type Deploy struct {
 	Created *bool `json:"created"`
 }

diff --git a/library/actions/doc.go b/library/actions/doc.go
@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+
+// Package actions provides the defined event action types for Vela.
+//
+// Deprecated: all event action types for Vela have been moved to github.com/go-vela/server/api/types/actions .
+//
+// This package is frozen.
+package actions
diff --git a/library/actions/pull.go b/library/actions/pull.go
@@ -6,6 +6,8 @@ import "github.com/go-vela/types/constants"
 
 // Pull is the library representation of the various actions associated
 // with the pull_request event webhook from the SCM.
+//
+// Deprecated: use Pull from github.com/go-vela/server/api/types/actions instead.
 type Pull struct {
 	Opened      *bool `json:"opened"`
 	Edited      *bool `json:"edited"`

diff --git a/library/actions/push.go b/library/actions/push.go
@@ -6,6 +6,8 @@ import "github.com/go-vela/types/constants"
 
 // Push is the library representation of the various actions associated
 // with the push event webhook from the SCM.
+//
+// Deprecated: use Push from github.com/go-vela/server/api/types/actions instead.
 type Push struct {
 	Branch       *bool `json:"branch"`
 	Tag          *bool `json:"tag"`

diff --git a/library/actions/schedule.go b/library/actions/schedule.go
@@ -7,6 +7,8 @@ import "github.com/go-vela/types/constants"
 
 // Schedule is the library representation of the various actions associated
 // with the schedule event.
+//
+// Deprecated: use Schedule from github.com/go-vela/server/api/types/actions instead.
 type Schedule struct {
 	Run *bool `json:"run"`
 }

diff --git a/library/build_executable.go b/library/build_executable.go
@@ -8,7 +8,7 @@ import (
 
 // BuildExecutable is the library representation of a BuildExecutable.
 //
-// swagger:model BuildExecutable
+// Deprecated: use BuildExecutable from github.com/go-vela/server/api/types instead.
 type BuildExecutable struct {
 	ID      *int64 `json:"id,omitempty"`
 	BuildID *int64 `json:"build_id,omitempty"`

diff --git a/library/build_queue.go b/library/build_queue.go
@@ -8,8 +8,6 @@ import "fmt"
 // BuildQueue is the library representation of the builds in the queue.
 //
 // Deprecated: use QueueBuild from github.com/go-vela/server/api/types instead.
-//
-// swagger:model BuildQueue
 type BuildQueue struct {
 	Status   *string `json:"status,omitempty"`
 	Number   *int32  `json:"number,omitempty"`

diff --git a/library/deployment.go b/library/deployment.go
@@ -10,7 +10,7 @@ import (
 
 // Deployment is the library representation of a deployment.
 //
-// swagger:model Deployment
+// Deprecated: use Deployment from github.com/go-vela/server/api/types instead.
 type Deployment struct {
 	ID          *int64              `json:"id,omitempty"`
 	Number      *int64              `json:"number,omitempty"`

diff --git a/library/doc.go b/library/doc.go
@@ -2,7 +2,7 @@
 
 // Package library provides the defined library types for Vela.
 //
-// Usage:
+// Deprecated: all library types for Vela have been moved to github.com/go-vela/server/api/types .
 //
-//	import "github.com/go-vela/types/library"
+// This package is frozen.
 package library
diff --git a/library/events.go b/library/events.go
@@ -13,6 +13,8 @@ import (
 
 // Events is the library representation of the various events that generate a
 // webhook from the SCM.
+//
+// Deprecated: use Events from github.com/go-vela/server/api/types instead.
 type Events struct {
 	Push        *actions.Push     `json:"push"`
 	PullRequest *actions.Pull     `json:"pull_request"`

diff --git a/library/log.go b/library/log.go
@@ -11,7 +11,7 @@ import (
 
 // Log is the library representation of a log for a step in a build.
 //
-// swagger:model Log
+// Deprecated: use Log from github.com/go-vela/server/api/types instead.
 type Log struct {
 	ID        *int64 `json:"id,omitempty"`
 	BuildID   *int64 `json:"build_id,omitempty"`

diff --git a/library/pipeline.go b/library/pipeline.go
@@ -8,7 +8,7 @@ import (
 
 // Pipeline is the library representation of a Pipeline.
 //
-// swagger:model Pipeline
+// Deprecated: use Pipeline from github.com/go-vela/server/api/types instead.
 type Pipeline struct {
 	ID              *int64  `json:"id,omitempty"`
 	RepoID          *int64  `json:"repo_id,omitempty"`

diff --git a/library/queue_info.go b/library/queue_info.go
@@ -4,7 +4,7 @@ package library
 
 // QueueInfo is the library representation of a QueueInfo.
 //
-// swagger:model QueueInfo
+// Deprecated: use QueueInfo from github.com/go-vela/server/api/types instead.
 type QueueInfo struct {
 	QueuePublicKey *string `json:"queue_public_key,omitempty"`
 	QueueAddress   *string `json:"queue_address,omitempty"`

diff --git a/library/secret.go b/library/secret.go
@@ -12,7 +12,7 @@ import (
 
 // Secret is the library representation of a secret.
 //
-// swagger:model Secret
+// Deprecated: use Secret from github.com/go-vela/server/api/types instead.
 type Secret struct {
 	ID                *int64    `json:"id,omitempty"`
 	Org               *string   `json:"org,omitempty"`

diff --git a/library/service.go b/library/service.go
@@ -13,7 +13,7 @@ import (
 
 // Service is the library representation of a service in a build.
 //
-// swagger:model Service
+// Deprecated: use Service from github.com/go-vela/server/api/types instead.
 type Service struct {
 	ID           *int64  `json:"id,omitempty"`
 	BuildID      *int64  `json:"build_id,omitempty"`

diff --git a/library/step.go b/library/step.go
@@ -13,7 +13,7 @@ import (
 
 // Step is the library representation of a step in a build.
 //
-// swagger:model Step
+// Deprecated: use Step from github.com/go-vela/server/api/types instead.
 type Step struct {
 	ID           *int64  `json:"id,omitempty"`
 	BuildID      *int64  `json:"build_id,omitempty"`

diff --git a/library/template.go b/library/template.go
@@ -9,7 +9,7 @@ import (
 
 // Template is the library representation of a template for a pipeline.
 //
-// swagger:model Template
+// Deprecated: use Template from github.com/go-vela/server/api/types instead.
 type Template struct {
 	Link   *string `json:"link,omitempty"`
 	Name   *string `json:"name,omitempty"`

diff --git a/library/token.go b/library/token.go
@@ -6,7 +6,7 @@ import "fmt"
 
 // Token is the library representation of a token response from server.
 //
-// swagger:model Token
+// Deprecated: use Token from github.com/go-vela/server/api/types instead.
 type Token struct {
 	Token *string `json:"token,omitempty"`
 }

diff --git a/metadata.go b/metadata.go
@@ -6,25 +6,33 @@ import "time"
 
 type (
 	// Database is the extra set of database data passed to the compiler.
+	//
+	// Deprecated: use Database from github.com/go-vela/server/internal instead.
 	Database struct {
 		Driver string `json:"driver"`
 		Host   string `json:"host"`
 	}
 
 	// Queue is the extra set of queue data passed to the compiler.
+	//
+	// Deprecated: use Queue from github.com/go-vela/server/internal instead.
 	Queue struct {
 		Channel string `json:"channel"`
 		Driver  string `json:"driver"`
 		Host    string `json:"host"`
 	}
 
 	// Source is the extra set of source data passed to the compiler.
+	//
+	// Deprecated: use Source from github.com/go-vela/server/internal instead.
 	Source struct {
 		Driver string `json:"driver"`
 		Host   string `json:"host"`
 	}
 
 	// Vela is the extra set of Vela data passed to the compiler.
+	//
+	// Deprecated: use Vela from github.com/go-vela/server/internal instead.
 	Vela struct {
 		Address              string        `json:"address"`
 		WebAddress           string        `json:"web_address"`
@@ -35,6 +43,8 @@ type (
 
 	// Metadata is the extra set of data passed to the compiler for
 	// converting a yaml configuration to an executable pipeline.
+	//
+	// Deprecated: use Metadata from github.com/go-vela/server/internal instead.
 	Metadata struct {
 		Database *Database `json:"database"`
 		Queue    *Queue    `json:"queue"`

diff --git a/pipeline/build.go b/pipeline/build.go
@@ -13,7 +13,7 @@ import (
 
 // Build is the pipeline representation of a build for a pipeline.
 //
-// swagger:model PipelineBuild
+// Deprecated: use Build from github.com/go-vela/server/compiler/types/pipeline instead.
 type Build struct {
 	ID          string             `json:"id,omitempty"       yaml:"id,omitempty"`
 	Version     string             `json:"version,omitempty"  yaml:"version,omitempty"`