Documentation
¶
Index ¶
- Constants
- Variables
- type ActionsOpts
- type ArtifactDownload
- type ArtifactDownloadOpts
- type ArtifactUpload
- type ArtifactUploadOpts
- type AttachedIntegrationAdd
- type AttachedIntegrationDelete
- type AttachedIntegrationItem
- type AttachedIntegrationList
- type AttestaionResultRunnerContext
- type AttestationAdd
- type AttestationAddOpts
- type AttestationInit
- type AttestationInitOpts
- type AttestationPush
- type AttestationPushOpts
- type AttestationReset
- type AttestationResetOpts
- type AttestationStatus
- type AttestationStatusOpts
- type AttestationStatusResult
- type AttestationStatusResultMaterial
- type AttestationStatusWorkflowMeta
- type AvailableIntegrationDescribe
- type AvailableIntegrationItem
- type AvailableIntegrationList
- type CASArtifact
- type ConfigContextItem
- type ConfigContextItemOCIRepo
- type ConfigContextItemUser
- type ConfigCurrentContext
- type DeleteAccount
- type EnvVar
- type ErrRunnerContextNotFound
- type JSONSchema
- type Material
- type MembershipItem
- type MembershipList
- type MembershipSetCurrent
- type NewOCIRepositorySaveOpts
- type NewWorkflowCreateOpts
- type OCIRepositorySave
- type OrgItem
- type PaginatedWorkflowRunItem
- type PaginationOpts
- type RegisteredIntegrationAdd
- type RegisteredIntegrationDelete
- type RegisteredIntegrationDescribe
- type RegisteredIntegrationItem
- type RegisteredIntegrationList
- type ValidationStatus
- type WorkflowContractCreate
- type WorkflowContractDelete
- type WorkflowContractDescribe
- type WorkflowContractItem
- type WorkflowContractList
- type WorkflowContractUpdate
- type WorkflowContractVersionItem
- type WorkflowContractWithVersionItem
- type WorkflowCreate
- type WorkflowDelete
- type WorkflowItem
- type WorkflowList
- type WorkflowRobotAccountCreate
- type WorkflowRobotAccountItem
- type WorkflowRobotAccountList
- type WorkflowRobotAccountRevoke
- type WorkflowRunAttestationItem
- type WorkflowRunDescribe
- type WorkflowRunItem
- type WorkflowRunItemFull
- type WorkflowRunList
- type WorkflowRunListOpts
Constants ¶
View Source
const AttestationResetTriggerCancelled = "cancellation"
View Source
const AttestationResetTriggerFailed = "failure"
Variables ¶
View Source
var ErrAttestationAlreadyExist = errors.New("attestation already initialized")
ErrAttestationAlreadyExist means that there is an attestation in progress
View Source
var ErrAttestationNotInitialized = errors.New("attestation not yet initialized")
Functions ¶
This section is empty.
Types ¶
type ActionsOpts ¶
type ActionsOpts struct {
CPConnection *grpc.ClientConn
Logger zerolog.Logger
}
type ArtifactDownload ¶
type ArtifactDownload struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewArtifactDownload ¶
func NewArtifactDownload(opts *ArtifactDownloadOpts) *ArtifactDownload
func (*ArtifactDownload) Run ¶
func (a *ArtifactDownload) Run(downloadPath, digest string) error
type ArtifactDownloadOpts ¶
type ArtifactDownloadOpts struct {
*ActionsOpts
ArtifactsCASConn *grpc.ClientConn
}
type ArtifactUpload ¶
type ArtifactUpload struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewArtifactUpload ¶
func NewArtifactUpload(opts *ArtifactUploadOpts) *ArtifactUpload
func (*ArtifactUpload) Run ¶
func (a *ArtifactUpload) Run(filePath string) (*CASArtifact, error)
type ArtifactUploadOpts ¶
type ArtifactUploadOpts struct {
*ActionsOpts
ArtifactsCASConn *grpc.ClientConn
}
type AttachedIntegrationAdd ¶ added in v0.11.1
type AttachedIntegrationAdd struct {
// contains filtered or unexported fields
}
Attach a third party integration to a workflow
func NewAttachedIntegrationAdd ¶ added in v0.11.1
func NewAttachedIntegrationAdd(cfg *ActionsOpts) *AttachedIntegrationAdd
func (*AttachedIntegrationAdd) Run ¶ added in v0.11.1
func (action *AttachedIntegrationAdd) Run(integrationID, workflowID string, options map[string]any) (*AttachedIntegrationItem, error)
type AttachedIntegrationDelete ¶ added in v0.11.1
type AttachedIntegrationDelete struct {
// contains filtered or unexported fields
}
func NewAttachedIntegrationDelete ¶ added in v0.11.1
func NewAttachedIntegrationDelete(cfg *ActionsOpts) *AttachedIntegrationDelete
func (*AttachedIntegrationDelete) Run ¶ added in v0.11.1
func (action *AttachedIntegrationDelete) Run(attachmentID string) error
type AttachedIntegrationItem ¶ added in v0.11.1
type AttachedIntegrationItem struct {
ID string `json:"id"`
CreatedAt *time.Time `json:"createdAt"`
Config map[string]interface{} `json:"config"`
Integration *RegisteredIntegrationItem `json:"integration"`
Workflow *WorkflowItem `json:"workflow"`
}
type AttachedIntegrationList ¶ added in v0.11.1
type AttachedIntegrationList struct {
// contains filtered or unexported fields
}
func NewAttachedIntegrationList ¶ added in v0.11.1
func NewAttachedIntegrationList(cfg *ActionsOpts) *AttachedIntegrationList
func (*AttachedIntegrationList) Run ¶ added in v0.11.1
func (action *AttachedIntegrationList) Run() ([]*AttachedIntegrationItem, error)
type AttestationAdd ¶
type AttestationAdd struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewAttestationAdd ¶
func NewAttestationAdd(cfg *AttestationAddOpts) *AttestationAdd
func (*AttestationAdd) Run ¶
func (action *AttestationAdd) Run(k, v string) error
type AttestationAddOpts ¶
type AttestationAddOpts struct {
*ActionsOpts
ArtifactsCASConn *grpc.ClientConn
}
type AttestationInit ¶
type AttestationInit struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewAttestationInit ¶
func NewAttestationInit(cfg *AttestationInitOpts) *AttestationInit
func (*AttestationInit) Run ¶
func (action *AttestationInit) Run(contractRevision int) error
type AttestationInitOpts ¶
type AttestationInitOpts struct {
*ActionsOpts
Override, DryRun bool
}
type AttestationPush ¶
type AttestationPush struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewAttestationPush ¶
func NewAttestationPush(cfg *AttestationPushOpts) *AttestationPush
func (*AttestationPush) Run ¶
func (action *AttestationPush) Run() (interface{}, error)
TODO: Return defined type
type AttestationPushOpts ¶
type AttestationPushOpts struct {
*ActionsOpts
KeyPath, CLIVersion, CLIDigest string
}
type AttestationReset ¶
type AttestationReset struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewAttestationReset ¶
func NewAttestationReset(opts *ActionsOpts) *AttestationReset
func (*AttestationReset) Run ¶
func (action *AttestationReset) Run(trigger, reason string) error
type AttestationResetOpts ¶
type AttestationResetOpts struct {
*ActionsOpts
}
type AttestationStatus ¶
type AttestationStatus struct {
*ActionsOpts
// contains filtered or unexported fields
}
func NewAttestationStatus ¶
func NewAttestationStatus(cfg *AttestationStatusOpts) *AttestationStatus
func (*AttestationStatus) Run ¶
func (action *AttestationStatus) Run() (*AttestationStatusResult, error)
type AttestationStatusOpts ¶
type AttestationStatusOpts struct {
*ActionsOpts
}
type AttestationStatusResult ¶
type AttestationStatusResult struct {
InitializedAt *time.Time
WorkflowMeta *AttestationStatusWorkflowMeta
Materials []AttestationStatusResultMaterial
EnvVars map[string]string
RunnerContext *AttestaionResultRunnerContext
DryRun bool
}
type AttestationStatusWorkflowMeta ¶
type AttestationStatusWorkflowMeta struct {
RunID, WorkflowID, Name, Team, Project, ContractRevision string
}
type AvailableIntegrationDescribe ¶ added in v0.11.1
type AvailableIntegrationDescribe struct {
// contains filtered or unexported fields
}
func NewAvailableIntegrationDescribe ¶ added in v0.11.1
func NewAvailableIntegrationDescribe(cfg *ActionsOpts) *AvailableIntegrationDescribe
func (*AvailableIntegrationDescribe) Run ¶ added in v0.11.1
func (action *AvailableIntegrationDescribe) Run(id string) (*AvailableIntegrationItem, error)
type AvailableIntegrationItem ¶ added in v0.11.1
type AvailableIntegrationItem struct {
ID string `json:"id"`
Version string `json:"version"`
Description string `json:"description,omitempty"`
Registration *JSONSchema `json:"registration"`
Attachment *JSONSchema `json:"attachment"`
// Subscribed inputs (material types)
SubscribedInputs []string `json:"subscribedInputs"`
}
type AvailableIntegrationList ¶ added in v0.11.1
type AvailableIntegrationList struct {
// contains filtered or unexported fields
}
func NewAvailableIntegrationList ¶ added in v0.11.1
func NewAvailableIntegrationList(cfg *ActionsOpts) *AvailableIntegrationList
func (*AvailableIntegrationList) Run ¶ added in v0.11.1
func (action *AvailableIntegrationList) Run() ([]*AvailableIntegrationItem, error)
type CASArtifact ¶
type CASArtifact struct {
Digest string
// contains filtered or unexported fields
}
type ConfigContextItem ¶
type ConfigContextItem struct {
CurrentUser *ConfigContextItemUser
CurrentOrg *OrgItem
CurrentOCIRepo *ConfigContextItemOCIRepo
}
type ConfigContextItemOCIRepo ¶
type ConfigContextItemOCIRepo struct {
ID, Repo string
CreatedAt *time.Time
ValidationStatus ValidationStatus
}
type ConfigContextItemUser ¶
type ConfigCurrentContext ¶
type ConfigCurrentContext struct {
// contains filtered or unexported fields
}
func NewConfigCurrentContext ¶
func NewConfigCurrentContext(cfg *ActionsOpts) *ConfigCurrentContext
func (*ConfigCurrentContext) Run ¶
func (action *ConfigCurrentContext) Run() (*ConfigContextItem, error)
type DeleteAccount ¶
type DeleteAccount struct {
*ActionsOpts
}
func NewDeleteAccount ¶
func NewDeleteAccount(cfg *ActionsOpts) *DeleteAccount
func (*DeleteAccount) Run ¶
func (a *DeleteAccount) Run() error
type ErrRunnerContextNotFound ¶
type ErrRunnerContextNotFound struct {
RunnerType string
}
func (ErrRunnerContextNotFound) Error ¶
func (e ErrRunnerContextNotFound) Error() string
type JSONSchema ¶ added in v0.11.1
type JSONSchema struct {
// Show it as raw string so the json output contains it
Raw string `json:"schema"`
// Parsed schema so it can be used for validation or other purposes
// It's not shown in the json output
Parsed *jsonschema.Schema `json:"-"`
Properties sdk.SchemaPropertiesMap `json:"-"`
}
type MembershipItem ¶
type MembershipList ¶
type MembershipList struct {
// contains filtered or unexported fields
}
func NewMembershipList ¶
func NewMembershipList(cfg *ActionsOpts) *MembershipList
func (*MembershipList) Run ¶
func (action *MembershipList) Run() ([]*MembershipItem, error)
type MembershipSetCurrent ¶
type MembershipSetCurrent struct {
// contains filtered or unexported fields
}
func NewMembershipSet ¶
func NewMembershipSet(cfg *ActionsOpts) *MembershipSetCurrent
func (*MembershipSetCurrent) Run ¶
func (action *MembershipSetCurrent) Run(id string) (*MembershipItem, error)
type NewOCIRepositorySaveOpts ¶
type NewOCIRepositorySaveOpts struct {
Repo, Username, Password string
}
type NewWorkflowCreateOpts ¶
type NewWorkflowCreateOpts struct {
Name, Project, Team, ContractID string
}
type OCIRepositorySave ¶
type OCIRepositorySave struct {
// contains filtered or unexported fields
}
func NewOCIRepositorySave ¶
func NewOCIRepositorySave(cfg *ActionsOpts) *OCIRepositorySave
func (*OCIRepositorySave) Run ¶
func (action *OCIRepositorySave) Run(opts *NewOCIRepositorySaveOpts) error
type PaginatedWorkflowRunItem ¶
type PaginatedWorkflowRunItem struct {
Result []*WorkflowRunItem
PaginationMeta *PaginationOpts
}
type PaginationOpts ¶
type RegisteredIntegrationAdd ¶ added in v0.11.1
type RegisteredIntegrationAdd struct {
// contains filtered or unexported fields
}
func NewRegisteredIntegrationAdd ¶ added in v0.11.1
func NewRegisteredIntegrationAdd(cfg *ActionsOpts) *RegisteredIntegrationAdd
func (*RegisteredIntegrationAdd) Run ¶ added in v0.11.1
func (action *RegisteredIntegrationAdd) Run(pluginID, description string, options map[string]any) (*RegisteredIntegrationItem, error)
type RegisteredIntegrationDelete ¶ added in v0.11.1
type RegisteredIntegrationDelete struct {
// contains filtered or unexported fields
}
func NewRegisteredIntegrationDelete ¶ added in v0.11.1
func NewRegisteredIntegrationDelete(cfg *ActionsOpts) *RegisteredIntegrationDelete
func (*RegisteredIntegrationDelete) Run ¶ added in v0.11.1
func (action *RegisteredIntegrationDelete) Run(id string) error
type RegisteredIntegrationDescribe ¶ added in v0.11.1
type RegisteredIntegrationDescribe struct {
// contains filtered or unexported fields
}
func NewRegisteredIntegrationDescribe ¶ added in v0.11.1
func NewRegisteredIntegrationDescribe(cfg *ActionsOpts) *RegisteredIntegrationDescribe
func (*RegisteredIntegrationDescribe) Run ¶ added in v0.11.1
func (action *RegisteredIntegrationDescribe) Run(id string) (*RegisteredIntegrationItem, error)
type RegisteredIntegrationItem ¶ added in v0.11.1
type RegisteredIntegrationItem struct {
ID string `json:"id"`
// Integration backend kind, i.e slack, pagerduty, etc
Kind string `json:"name"`
// Integration description for display and differentiation purposes
Description string `json:"description"`
CreatedAt *time.Time `json:"createdAt"`
Config map[string]interface{} `json:"config"`
}
type RegisteredIntegrationList ¶ added in v0.11.1
type RegisteredIntegrationList struct {
// contains filtered or unexported fields
}
func NewRegisteredIntegrationList ¶ added in v0.11.1
func NewRegisteredIntegrationList(cfg *ActionsOpts) *RegisteredIntegrationList
func (*RegisteredIntegrationList) Run ¶ added in v0.11.1
func (action *RegisteredIntegrationList) Run() ([]*RegisteredIntegrationItem, error)
type ValidationStatus ¶
type ValidationStatus string
const ( Valid ValidationStatus = "valid" Invalid ValidationStatus = "invalid" )
type WorkflowContractCreate ¶
type WorkflowContractCreate struct {
// contains filtered or unexported fields
}
func NewWorkflowContractCreate ¶
func NewWorkflowContractCreate(cfg *ActionsOpts) *WorkflowContractCreate
func (*WorkflowContractCreate) Run ¶
func (action *WorkflowContractCreate) Run(name, contractPath string) (*WorkflowContractItem, error)
type WorkflowContractDelete ¶
type WorkflowContractDelete struct {
// contains filtered or unexported fields
}
func NewWorkflowContractDelete ¶
func NewWorkflowContractDelete(cfg *ActionsOpts) *WorkflowContractDelete
func (*WorkflowContractDelete) Run ¶
func (action *WorkflowContractDelete) Run(contractID string) error
type WorkflowContractDescribe ¶
type WorkflowContractDescribe struct {
// contains filtered or unexported fields
}
func NewWorkflowContractDescribe ¶
func NewWorkflowContractDescribe(cfg *ActionsOpts) *WorkflowContractDescribe
func (*WorkflowContractDescribe) Run ¶
func (action *WorkflowContractDescribe) Run(id string, rev int32) (*WorkflowContractWithVersionItem, error)
type WorkflowContractItem ¶
type WorkflowContractList ¶
type WorkflowContractList struct {
// contains filtered or unexported fields
}
func NewWorkflowContractList ¶
func NewWorkflowContractList(cfg *ActionsOpts) *WorkflowContractList
func (*WorkflowContractList) Run ¶
func (action *WorkflowContractList) Run() ([]*WorkflowContractItem, error)
type WorkflowContractUpdate ¶
type WorkflowContractUpdate struct {
// contains filtered or unexported fields
}
func NewWorkflowContractUpdate ¶
func NewWorkflowContractUpdate(cfg *ActionsOpts) *WorkflowContractUpdate
func (*WorkflowContractUpdate) Run ¶
func (action *WorkflowContractUpdate) Run(contractID, name, contractPath string) (*WorkflowContractWithVersionItem, error)
type WorkflowContractWithVersionItem ¶
type WorkflowContractWithVersionItem struct {
Contract *WorkflowContractItem `json:"contract"`
Revision *WorkflowContractVersionItem `json:"revision"`
}
type WorkflowCreate ¶
type WorkflowCreate struct {
// contains filtered or unexported fields
}
func NewWorkflowCreate ¶
func NewWorkflowCreate(cfg *ActionsOpts) *WorkflowCreate
func (*WorkflowCreate) Run ¶
func (action *WorkflowCreate) Run(opts *NewWorkflowCreateOpts) (*WorkflowItem, error)
type WorkflowDelete ¶
type WorkflowDelete struct {
// contains filtered or unexported fields
}
func NewWorkflowDelete ¶
func NewWorkflowDelete(cfg *ActionsOpts) *WorkflowDelete
func (*WorkflowDelete) Run ¶
func (action *WorkflowDelete) Run(workflowID string) error
type WorkflowItem ¶
type WorkflowItem struct {
Name string `json:"name"`
ID string `json:"id"`
Team string `json:"team"`
Project string `json:"project,omitempty"`
CreatedAt *time.Time `json:"createdAt"`
RunsCount int32 `json:"runsCount"`
ContractID string `json:"contractID,omitempty"`
LastRun *WorkflowRunItem `json:"lastRun,omitempty"`
}
func (*WorkflowItem) NamespacedName ¶
func (wi *WorkflowItem) NamespacedName() string
type WorkflowList ¶
type WorkflowList struct {
// contains filtered or unexported fields
}
func NewWorkflowList ¶
func NewWorkflowList(cfg *ActionsOpts) *WorkflowList
func (*WorkflowList) Run ¶
func (action *WorkflowList) Run() ([]*WorkflowItem, error)
type WorkflowRobotAccountCreate ¶
type WorkflowRobotAccountCreate struct {
// contains filtered or unexported fields
}
func NewWorkflowRobotAccountCreate ¶
func NewWorkflowRobotAccountCreate(cfg *ActionsOpts) *WorkflowRobotAccountCreate
func (*WorkflowRobotAccountCreate) Run ¶
func (action *WorkflowRobotAccountCreate) Run(workflowID, name string) (*WorkflowRobotAccountItem, error)
type WorkflowRobotAccountList ¶
type WorkflowRobotAccountList struct {
// contains filtered or unexported fields
}
func NewWorkflowRobotAccountList ¶
func NewWorkflowRobotAccountList(cfg *ActionsOpts) *WorkflowRobotAccountList
func (*WorkflowRobotAccountList) Run ¶
func (action *WorkflowRobotAccountList) Run(workflowID string, includeRevoked bool) ([]*WorkflowRobotAccountItem, error)
type WorkflowRobotAccountRevoke ¶
type WorkflowRobotAccountRevoke struct {
// contains filtered or unexported fields
}
func NewWorkflowRobotAccountRevoke ¶
func NewWorkflowRobotAccountRevoke(cfg *ActionsOpts) *WorkflowRobotAccountRevoke
func (*WorkflowRobotAccountRevoke) Run ¶
func (action *WorkflowRobotAccountRevoke) Run(accountID string) error
type WorkflowRunAttestationItem ¶
type WorkflowRunAttestationItem struct {
ID string `json:"id"`
CreatedAt *time.Time `json:"createdAt"`
Envelope *dsse.Envelope `json:"envelope"`
Materials []*Material `json:"materials,omitempty"`
EnvVars []*EnvVar `json:"envvars,omitempty"`
// contains filtered or unexported fields
}
func (*WorkflowRunAttestationItem) Statement ¶
func (i *WorkflowRunAttestationItem) Statement() *in_toto.Statement
type WorkflowRunDescribe ¶
type WorkflowRunDescribe struct {
// contains filtered or unexported fields
}
func NewWorkflowRunDescribe ¶
func NewWorkflowRunDescribe(cfg *ActionsOpts) *WorkflowRunDescribe
func (*WorkflowRunDescribe) Run ¶
func (action *WorkflowRunDescribe) Run(runID string, verify bool, publicKey string) (*WorkflowRunItemFull, error)
type WorkflowRunItem ¶
type WorkflowRunItem struct {
ID string `json:"id"`
State string `json:"state"`
Reason string `json:"reason,omitempty"`
CreatedAt *time.Time `json:"createdAt,omitempty"`
FinishedAt *time.Time `json:"finishedAt,omitempty"`
Workflow *WorkflowItem `json:"workflow,omitempty"`
RunURL string `json:"runURL,omitempty"`
RunnerType string `json:"runnerType,omitempty"`
ContractVersion *WorkflowContractVersionItem `json:"contractVersion,omitempty"`
}
type WorkflowRunItemFull ¶
type WorkflowRunItemFull struct {
WorkflowRun *WorkflowRunItem `json:"workflowRun"`
Workflow *WorkflowItem `json:"workflow"`
Attestation *WorkflowRunAttestationItem `json:"attestation,omitempty"`
Verified bool `json:"verified"`
}
type WorkflowRunList ¶
type WorkflowRunList struct {
// contains filtered or unexported fields
}
func NewWorkflowRunList ¶
func NewWorkflowRunList(cfg *ActionsOpts) *WorkflowRunList
func (*WorkflowRunList) Run ¶
func (action *WorkflowRunList) Run(opts *WorkflowRunListOpts) (*PaginatedWorkflowRunItem, error)
type WorkflowRunListOpts ¶
type WorkflowRunListOpts struct {
WorkflowID string
Pagination *PaginationOpts
}
Source Files
¶
- action.go
- artifact_download.go
- artifact_upload.go
- attached_integration_add.go
- attached_integration_delete.go
- attached_integration_list.go
- attestation_add.go
- attestation_init.go
- attestation_push.go
- attestation_reset.go
- attestation_status.go
- available_integration_describe.go
- available_integration_list.go
- config_current_context.go
- delete_account.go
- membership_list.go
- membership_set.go
- ocirepository_save.go
- registered_integration_add.go
- registered_integration_delete.go
- registered_integration_describe.go
- registered_integration_list.go
- workflow_contract_create.go
- workflow_contract_delete.go
- workflow_contract_describe.go
- workflow_contract_list.go
- workflow_contract_update.go
- workflow_create.go
- workflow_delete.go
- workflow_list.go
- workflow_robotaccount_create.go
- workflow_robotaccount_list.go
- workflow_robotaccount_revoke.go
- workflow_run_describe.go
- workflow_run_list.go
Click to show internal directories.
Click to hide internal directories.