spec

type NCISpec interface {
	Validate() error
}

type NCIValidationError struct {
	Field       string
	Value       string
	Description string
}

type NormalizeCISpec struct {
	Found       string `validate:"required"`         // Will be set the true, if the variables have been normalized. (this script)
	Version     string `validate:"required"`         // The revision of nci that was used to generate the normalized variables.
	ServiceName string `validate:"required"`         // The commercial name of the used ci service. (e.g. GitLab CI, Travis CI, CircleCI, Jenkins)
	ServiceSlug string `validate:"required,is-slug"` // The commercial name normalized as slug for use in scripts, will not be changed.

	WorkerId      string `validate:"required"` // A unique id of the ci worker.
	WorkerName    string `validate:"required"` // The human readable name of the ci worker.
	WorkerType    string `validate:"required"`
	WorkerOS      string // Worker OS or OS Image
	WorkerVersion string `validate:"required"`         // The version of the ci worker.
	WorkerArch    string `validate:"required,is-arch"` // The arch of the ci worker. (ie. linux/amd64)

	PipelineId           string `validate:"required"`
	PipelineTrigger      string `validate:"required,oneof=cli manual push trigger api schedule pull_request build"` // What triggered the pipeline. (ie. manual/push/trigger/api/schedule/pull_request/build)
	PipelineStageId      string
	PipelineStageName    string `validate:"required"`         // Human readable name of the current stage.
	PipelineStageSlug    string `validate:"required,is-slug"` // Slug of the current stage.
	PipelineJobId        string
	PipelineJobName      string `validate:"required"`         // Human readable name of the current job.
	PipelineJobSlug      string `validate:"required,is-slug"` // Slug of the current job.
	PipelineJobStartedAt string `validate:"required"`
	PipelineAttempt      string `validate:"number"`
	PipelineConfigFile   string // Pipeline Config File
	PipelineUrl          string // Pipeline URL
	PipelineInput        map[string]string

	MergeRequestId               string `validate:"required_if=PipelineTrigger pull_request"` // The number of the pull request, is only present if `PipelineTrigger` = pull_request.
	MergeRequestSourceBranchName string
	MergeRequestTargetBranchName string

	ProjectId            string // Unique project id, can be used in deployments.
	ProjectName          string // Unique project id, can be used in deployments.
	ProjectPath          string // Path of the Namespace and the project
	ProjectSlug          string `validate:"required,is-slug"` // Project slug, that can be used in deployments.
	ProjectDescription   string // The project description.
	ProjectTopics        string // The topics / tags of the project.
	ProjectIssueUrl      string // A template for links to issues, contains a `{ID}` placeholder.
	ProjectStargazers    string `validate:"number"` // The number of people who `follow` / `bookmarked` the project.
	ProjectForks         string `validate:"number"` // The number of forks of the project.
	ProjectDir           string // Project directory on the local filesystem.
	ProjectUrl           string
	ProjectDefaultBranch string `` // The default branch

	ContainerRegistryHost       string // The hostname of the container registry.
	ContainerRegistryUsername   string // The username used for container registry authentication.
	ContainerRegistryPassword   string // The password used for container registry authentication.
	ContainerRegistryRepository string `validate:"required"` // The repository, that should be used for the current project.
	ContainerRegistryTag        string `validate:"required"` // The tag that should be build.

	RepositoryKind       string `validate:"required"` //  The used version control system. (git)
	RepositoryRemote     string `validate:"required"` // The remote url pointing at the repository. (git remote url or `local` if no remote was found)
	RepositoryHostServer string `validate:"required"` // Host of the git repository server, for example github.com
	RepositoryHostType   string `validate:"required"` // Type of the git repository server (github, gitlab, ...)
	RepositoryStatus     string `validate:"required"` // The repository status (dirty, clean)
	CommitRefType        string `validate:"required"` // The reference type. (branch / tag)
	CommitRefName        string `validate:"required"` // Human-readable name of the current repository reference.
	CommitRefPath        string `validate:"required"` // Combination of the ref type and ref name. (tag/v1.0.0 or branch/main)
	CommitRefSlug        string `validate:"required"` // Slug of the current repository reference.
	CommitRefVcs         string `validate:"required"` // Holds the vcs specific absolute reference name. (ex: `refs/heads/main`)// Release version of the artifact, without leading `v` or `/` - should be in format `x.y.z` or `feature-abc`.
	CommitRefRelease     string `validate:"required"` // Release version of the artifact, without leading `v` or `/` - should be in format `x.y.z` or `feature-abc`.
	CommitSha            string `validate:"required"` // A unique hash, that each commit gets.
	CommitShaShort       string `validate:"required"` // A short form of the unique commit hash. (8 chars)
	CommitAuthorName     string `validate:"required"` // author name
	CommitAuthorEmail    string `validate:"required"` // author email
	CommitCommitterName  string `validate:"required"` // committer name
	CommitCommitterEmail string `validate:"required"` // committer email
	CommitTitle          string `validate:"required"` // The title of the latest commit on the current reference.
	CommitDescription    string // The description of the latest commit on the current reference.
	CommitCount          string `validate:"required"` // The total amount of commits inside of the current reference, can be used as build number.

	LastreleaseRefName          string `validate:"required"` // Human readable name of the last stable release.
	LastreleaseRefSlug          string `validate:"required"` // Slug of the last stable release.
	LastreleaseRefVcs           string `validate:"required"` // Holds the vcs specific absolute reference name of the last stable release. (ex: `refs/heads/main`)
	LastreleaseCommitAfterCount string `validate:"required"` // Holds the count of commits since the last stable release.

	DeployFreeze string `validate:"required,boolean"` // Currently in a deploy freeze window? (`true`, `false`)
}