starter

package

v0.0.97 Latest Latest Go to latest Published: Oct 25, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/colony-2/c2j

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func RestartRecipeJob(ctx context.Context, engine any, prior jobdb.JobKey, scopeID string, ...) (jobref.Ref, error)
func StartRecipeJob(ctx context.Context, startJob workflowctl.StartJob, engine any, ...) (jobref.Ref, error)
func StartRecipeJobWithOptions(ctx context.Context, startJob workflowctl.StartJob, engine any, ...) (jobref.Ref, error)
type JobMetadata
- func JobMetadataFromStartJob(startJob workflowctl.StartJob) JobMetadata
type RestartOptions
type StartRecipeJobOptions

Constants ¶

View Source

const (
	RecipeJobType        = "recipe"
	RecipeArtifactSuffix = ".recipe.yaml"
)

View Source

const (
	JobMetadataVersion = 1

	MetaFieldVersion  jobdb.FieldName = "v"
	MetaFieldRecipe   jobdb.FieldName = "recipe"
	MetaFieldPrompt   jobdb.FieldName = "prompt"
	MetaFieldCellID   jobdb.FieldName = "cell_id"
	MetaFieldCellName jobdb.FieldName = "cell_name"
	MetaFieldRepo     jobdb.FieldName = "repo"
	MetaFieldGitRef   jobdb.FieldName = "git_ref"

	MetaFieldParentTenantID       jobdb.FieldName = "parent_tenant_id"
	MetaFieldParentJobID          jobdb.FieldName = "parent_job_id"
	MetaFieldParentJobType        jobdb.FieldName = "parent_job_type"
	MetaFieldParentOpType         jobdb.FieldName = "parent_op_type"
	MetaFieldParentOpStep         jobdb.FieldName = "parent_op_step"
	MetaFieldParentOpTaskType     jobdb.FieldName = "parent_op_task_type"
	MetaFieldParentCellName       jobdb.FieldName = "parent_cell_name"
	MetaFieldParentRepo           jobdb.FieldName = "parent_repo"
	MetaFieldParentGitRef         jobdb.FieldName = "parent_git_ref"
	MetaFieldParentInvocationPath jobdb.FieldName = "parent_invocation_path"
	MetaFieldParentInvocationSeq  jobdb.FieldName = "parent_invocation_seq"
	MetaFieldParentInvocationHash jobdb.FieldName = "parent_invocation_hash"
)

Variables ¶

This section is empty.

Functions ¶

func RestartRecipeJob ¶

func RestartRecipeJob(ctx context.Context, engine any, prior jobdb.JobKey, scopeID string, patch *task.ContextPatch, opts RestartOptions) (jobref.Ref, error)

func StartRecipeJob ¶

func StartRecipeJob(ctx context.Context, startJob workflowctl.StartJob, engine any, recipes ...recipe.Recipe) (jobref.Ref, error)

func StartRecipeJobWithOptions ¶

func StartRecipeJobWithOptions(ctx context.Context, startJob workflowctl.StartJob, engine any, opts StartRecipeJobOptions, recipes ...recipe.Recipe) (jobref.Ref, error)

Types ¶

type JobMetadata ¶

type JobMetadata struct {
	Execution        *execution.Submission `json:"execution,omitempty"`
	InputHash        string                `json:"input_hash,omitempty"`
	SubmittedAt      *time.Time            `json:"submitted_at,omitempty"`
	Version          int                   `json:"v"`
	RecipeName       string                `json:"recipe,omitempty"`
	Prompt           string                `json:"prompt,omitempty"`
	CellID           string                `json:"cell_id,omitempty"`
	CellName         string                `json:"cell_name,omitempty"`
	RepositorySource string                `json:"repo,omitempty"`
	GitRef           string                `json:"git_ref,omitempty"`

	ParentTenantID           string `json:"parent_tenant_id,omitempty"`
	ParentGoalID             string `json:"parent_goal_id,omitempty"`
	ParentJobID              string `json:"parent_job_id,omitempty"`
	ParentJobType            string `json:"parent_job_type,omitempty"`
	ParentOpType             string `json:"parent_op_type,omitempty"`
	ParentOpStep             string `json:"parent_op_step,omitempty"`
	ParentOpTaskType         string `json:"parent_op_task_type,omitempty"`
	ParentCellName           string `json:"parent_cell_name,omitempty"`
	ParentRepositorySource   string `json:"parent_repo,omitempty"`
	ParentGitRef             string `json:"parent_git_ref,omitempty"`
	ParentInvocationPath     string `json:"parent_invocation_path,omitempty"`
	ParentInvocationSequence int64  `json:"parent_invocation_seq,omitempty"`
	ParentInvocationHash     string `json:"parent_invocation_hash,omitempty"`
}

func JobMetadataFromStartJob ¶

func JobMetadataFromStartJob(startJob workflowctl.StartJob) JobMetadata

type RestartOptions ¶ added in v0.0.94

type RestartOptions struct {
	Goal      string
	RequestID string
}

RestartRecipeJob starts a fresh continuation at a recorded, patchable scope.

type StartRecipeJobOptions ¶

type StartRecipeJobOptions struct {
	ExecutionRequirements execution.Requirements
	JobID                 string
	Dependencies          []jobdb.Dependency
}

Source Files ¶

View all Source files

start_recipe.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL