package
0.26.0
Repository: https://github.com/go-vela/types.git
Documentation: pkg.go.dev

# Constants

ActionBranch defines the action for deleting a branch.
ActionCreated defines the action for creating deployments or issue comments.
ActionEdited defines the action for the editing of pull requests or issue comments.
ActionLabeled defines the action for the labeling of pull requests.
ActionOpened defines the action for opening pull requests.
ActionRenamed defines the action for renaming a repository.
ActionReopened defines the action for re-opening a pull request (or issue).
ActionRun defines the action for running a schedule.
ActionSynchronize defines the action for the synchronizing of pull requests.
ActionTag defines the action for deleting a tag.
ActionTransferred defines the action for transferring repository ownership.
ActionUnlabeled defines the action for the unlabeling of pull requests.
Allowed repo events.
Allowed repo events.
Allowed repo events.
...
Allowed repo events.
00000100 = 4.
Allowed repo events.
Allowed repo events.
Allowed repo events.
00000001 = 1.
Allowed repo events.
Allowed repo events.
00000010 = 2.
Allowed repo events.
ApproveForkAlways defines the CI strategy of having a repo administrator approve all builds triggered from a forked PR.
ApproveForkNoWrite defines the CI strategy of having a repo administrator approve all builds triggered from a forked PR where the author does not have write access.
ApproveNever defines the CI strategy of never having to approve CI builds from outside contributors.
ApproveOnce defines the CI strategy of having a repo administrator approve all builds triggered from an outside contributor if this is their first time contributing.
Badge for error state <svg xmlns="http://www.w3.org/2000/svg" width="69" height="20"> <linearGradient id="a" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <path d="M0 3 a3 3 0 014-3h30v20H3 a3 3 0 01-3-3V3z" fill="#555555"/> <path d="M69 17 a3 3 0 01-3 3H32V0h33 a3 3 0 014 3v12z" fill="#e05d44"/> <rect width="100%" height="100%" rx="3" fill="url(#a)"/> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="16" y="14" fill="#010101" fill-opacity=".3" textLength="24" lengthAdjust="spacing">vela</text> <text x="16" y="13" textlength="24" lengthadjust="spacing">vela</text> <text x="50" y="14" fill="#010101" fill-opacity=".3" textlength="46" lengthadjust="spacing">error</text> <text x="50" y="13" textlength="46" lengthadjust="spacing">error</text> </g> </svg>.
Badge for failed state <svg xmlns="http://www.w3.org/2000/svg" width="73" height="20"> <linearGradient id="a" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <path d="M0 3 a3 3 0 014-3h30v20H3 a3 3 0 01-3-3V3z" fill="#555555"/> <path d="M73 17 a3 3 0 01-3 3H32V0h37 a3 3 0 014 3v12z" fill="#fe7d37"/> <rect width="100%" height="100%" rx="3" fill="url(#a)"/> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="16" y="14" fill="#010101" fill-opacity=".3" textLength="24" lengthAdjust="spacing">vela</text> <text x="16" y="13" textlength="24" lengthadjust="spacing">vela</text> <text x="52" y="14" fill="#010101" fill-opacity=".3" textlength="46" lengthadjust="spacing">failed</text> <text x="52" y="13" textlength="46" lengthadjust="spacing">failed</text> </g> </svg>.
Badge for running status <svg xmlns="http://www.w3.org/2000/svg" width="88" height="20"> <linearGradient id="b" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <path d="M0 3 a3 3 0 014-3h28v20H3 a3 3 0 01-3-3V3z" fill="#555555"/> <path d="M88 17 a3 3 0 01-3 3H32V0h52 a3 3 0 014 3v12z" fill="#dfb317"/> <rect width="100%" height="100%" rx="3" fill="url(#b)"/> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="16" y="14" fill="#010101" fill-opacity=".3" textLength="24" lengthAdjust="spacing">vela</text> <text x="16" y="13" textLength="24" lengthAdjust="spacing">vela</text> <text x="59" y="14" fill="#010101" fill-opacity=".3" textLength="46" lengthAdjust="spacing">running</text> <text x="59" y="13" textLength="46" lengthAdjust="spacing">running</text> </g> </svg>.
Badge for success state <svg xmlns="http://www.w3.org/2000/svg" width="85" height="20"> <linearGradient id="a" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <path d="M0 3 a3 3 0 014-3h30v20H3 a3 3 0 01-3-3V3z" fill="#555555"/> <path d="M85 17 a3 3 0 01-3 3H32V0h49 a3 3 0 014 3v12z" fill="#44cc11"/> <rect width="100%" height="100%" rx="3" fill="url(#a)"/> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="16" y="14" fill="#010101" fill-opacity=".3" textLength="24" lengthAdjust="spacing">vela</text> <text x="16" y="13" textlength="24" lengthadjust="spacing">vela</text> <text x="58" y="14" fill="#010101" fill-opacity=".3" textlength="46" lengthadjust="spacing">success</text> <text x="58" y="13" textlength="46" lengthadjust="spacing">success</text> </g> </svg>.
Badge for unknown state <svg xmlns="http://www.w3.org/2000/svg" width="92" height="20"> <linearGradient id="b" x2="0" y2="100%"> <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> <stop offset="1" stop-opacity=".1"/> </linearGradient> <path d="M0 3 a3 3 0 014-3h28v20H3 a3 3 0 01-3-3V3z" fill="#555555"/> <path d="M92 17 a3 3 0 01-3 3H32V0h56 a3 3 0 014 3v12z" fill="#9f9f9f"/> <rect width="100%" height="100%" rx="3" fill="url(#b)"/> <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"> <text x="16" y="14" fill="#010101" fill-opacity=".3" textLength="24" lengthAdjust="spacing">vela</text> <text x="16" y="13" textLength="24" lengthAdjust="spacing">vela</text> <text x="62" y="14" fill="#010101" fill-opacity=".3" textLength="52" lengthAdjust="spacing">unknown</text> <text x="62" y="13" textLength="52" lengthAdjust="spacing">unknown</text> </g> </svg>.
BuildLimitDefault defines the default value for repo concurrent build limit.
BuildLimitMax defines the maximum value for repo concurrent build limit.
BuildLimitMin defines the minimum value for repo concurrent build limit.
BuildTimeoutDefault defines the default value in minutes for repo build timeout.
BuildTimeoutMax defines the maximum value in minutes for repo build timeout.
BuildTimeoutMin defines the minimum value in minutes for repo build timeout.
Eighth compression level for log data stored in the database.
Enables an even balance of speed and compression for log data stored in the database.
Fourth compression level for log data stored in the database.
The default compression level for the compress/zlib library for log data stored in the database.
Enables the best compression for log data stored in the database.
Enables the best speed for log data stored in the database.
Seventh compression level for log data stored in the database.
Sixth compression level for log data stored in the database.
Third compression level for log data stored in the database.
Second compression level for log data stored in the database.
Enables no compression for log data stored in the database.
DefaultRoute defines the default route all workers listen on.
DeployBuildsMaxSize defines the maximum size in characters for deployment builds.
DriverDarwin defines the driver type when integrating with a darwin distribution.
DriverDocker defines the driver type when integrating with a Docker runtime.
DriverGitHub defines the driver type when integrating with a Github source code system.
DriverGitLab defines the driver type when integrating with a Gitlab source code system.
DriverKafka defines the driver type when integrating with a Kafka queue.
DriverKubernetes defines the driver type when integrating with a Kubernetes runtime.
DriverLinux defines the driver type when integrating with a linux distribution.
DriverLocal defines the driver type when integrating with a local system.
DriverNative defines the driver type when integrating with a Vela secret service.
DriverPostgres defines the driver type when integrating with a PostgreSQL database.
DriverRedis defines the driver type when integrating with a Redis queue.
DriverSqlite defines the driver type when integrating with a SQLite database.
DriverVault defines the driver type when integrating with a Vault secret service.
DriverWindows defines the driver type when integrating with a windows distribution.
EventComment defines the event type for comments added to a pull request.
EventDelete defines the event type for build and repo delete events.
EventDeploy defines the event type for build and repo deployment events.
EventDeployAlternate defines the alternate event type for build and repo deployment events.
EventPull defines the event type for build and repo pull_request events.
EventPullAlternate defines the alternate event type for build and repo pull_request events.
EventPush defines the event type for build and repo push events.
EventRepository defines the general event type for repo management.
EventSchedule defines the event type for build and repo schedule events.
EventTag defines the event type for build and repo tag events.
FavoritesMaxSize defines the maximum size in characters for user favorites.
MatcherFilepath defines the ruleset type for the filepath matcher.
MatcherRegex defines the ruleset type for the regex matcher.
OperatorAnd defines the ruleset type for the and operator.
OperatorOr defines the ruleset type for the or operator.
PipelineStages defines the type for a pipeline with stages.
PipelineStep defines the type for a pipeline with steps.
PipelineTemplate defines the type for a pipeline as a template.
PipelineTypeGo defines the pipeline type for allowing users in Vela to control their pipeline being compiled as Go templates.
PipelineTypeStarlark defines the pipeline type for allowing users in Vela to control their pipeline being compiled as Starlark templates.
PipelineTypeYAML defines the pipeline type for allowing users in Vela to control their pipeline being compiled as yaml.
PullAlways defines the pull policy type for a service or step to always pull an image.
PullNever defines the pull policy type for a service or step to never pull an image.
PullNotPresent defines the pull policy type for a service or step to only pull an image if it doesn't exist.
PullOnStart defines the pull policy type for a service or step to only pull an image before the container starts.
RefreshTokenName is the name associated with the refresh token.
ReportStepStatusLimit defines the maximum number of steps in a pipeline that may report their status to the SCM.
RunningBuildIDsMaxSize defines the maximum size in characters for worker RunningBuildIDs.
SecretLogMask defines the secret mask to be used when distributing logs that contain secrets.
SecretMask defines the secret mask to be used in place of secret values returned to users.
SecretOrg defines the secret type for a secret scoped to a specific org.
SecretPullBuild defines the pull policy type for a secret.
SecretPullStep defines the pull policy type for a secret.
SecretRepo defines the secret type for a secret scoped to a specific repo.
SecretRestrictedCharacters defines the set of characters that a secret name cannot contain.
SecretShared defines the secret type for a secret shared across the installation.
ServerWorkerTokenType is the name associated with the server-worker symmetric token.
StatusCanceled defines the status type for build and step canceled statuses.
StatusError defines the status type for build and step error statuses.
StatusFailure defines the status type for build and step failure statuses.
StatusKilled defines the status type for build and step killed statuses.
StatusPending defines the status type for build and step pending statuses.
StatusPendingApproval defines the status type for a build waiting to be approved to run.
StatusRunning defines the status type for build and step running statuses.
StatusSkipped defines the status type for build and step skipped statuses.
StatusSuccess defines the status type for build and step success statuses.
TableBuild defines the table type for the database builds table.
TableBuildExecutable defines the table type for the database build_executables table.
TableDeployment defines the table type for the database deployments table.
TableHook defines the table type for the database hooks table.
TableLog defines the table type for the database logs table.
TablePipeline defines the table type for the database pipelines table.
TableRepo defines the table type for the database repos table.
TableSchedule defines the table type for the database schedules table.
TableSecret defines the table type for the database secrets table.
TableService defines the table type for the database services table.
TableStep defines the table type for the database steps table.
TableUser defines the table type for the database users table.
TableWorker defines the table type for the database workers table.
TopicsMaxSize defines the maximum size in characters for repo topics.
UserAccessTokenType is the name associated with the user access token type.
UserRefreshTokenType is the name associated with the user refresh token type.
VisibilityPrivate defines the visibility type for only allowing users in Vela with pre-defined access in the source control system to access their repo.
VisibilityPublic defines the visibility type for allowing any users in Vela to access their repo regardless of the access defined in the source control system.
WorkerAuthTokenType is the name associated with the worker authentication token type.
WorkerBuildTokenType is the name associated with the worker build token type.
WorkerRegisterTokenType is the name associated with the worker registration token type.
WorkerStatusAvailable defines the status type for a worker in an available state, where worker RunningBuildIDs.length > 0 and < worker BuildLimit.
WorkerStatusBusy defines the status type for a worker in an unavailable state, where worker BuildLimit == worker RunningBuildIDs.length.
WorkerStatusError defines the status for a worker in an error state.
WorkerStatusIdle defines the status for a worker where worker RunningBuildIDs.length = 0.
WorkspaceDefault defines the default workspace path for a service or a step.
WorkspaceMount defines the mount workspace path for a service or a step.