Documentation
¶
Index ¶
- Variables
- func AllPreviousCompleted(ctx context.Context, completedDir string, n int) bool
- func Content(ctx context.Context, path string) (string, error)
- func HasExecuting(ctx context.Context, dir string) bool
- func MoveToCompleted(ctx context.Context, path string, completedDir string, mover FileMover) error
- func ResetExecuting(ctx context.Context, dir string) error
- func ResetFailed(ctx context.Context, dir string) error
- func SetBranch(ctx context.Context, path string, branch string) error
- func SetContainer(ctx context.Context, path string, container string) error
- func SetPRURL(ctx context.Context, path string, url string) error
- func SetStatus(ctx context.Context, path string, status string) error
- func SetVersion(ctx context.Context, path string, version string) error
- func Title(ctx context.Context, path string) (string, error)
- type FileMover
- type Frontmatter
- type Manager
- type Prompt
- type PromptFile
- func (pf *PromptFile) Branch() string
- func (pf *PromptFile) Content() (string, error)
- func (pf *PromptFile) MarkCompleted()
- func (pf *PromptFile) MarkFailed()
- func (pf *PromptFile) MarkQueued()
- func (pf *PromptFile) PRURL() string
- func (pf *PromptFile) PrepareForExecution(container, version string)
- func (pf *PromptFile) Save(ctx context.Context) error
- func (pf *PromptFile) SetBranch(branch string)
- func (pf *PromptFile) SetPRURL(url string)
- func (pf *PromptFile) SetSummary(summary string)
- func (pf *PromptFile) Title() string
- type Rename
- type Status
Constants ¶
This section is empty.
Variables ¶
var ErrEmptyPrompt = stderrors.New("prompt file is empty")
ErrEmptyPrompt is returned when a prompt file is empty or contains only whitespace.
Functions ¶
func AllPreviousCompleted ¶ added in v0.4.0
AllPreviousCompleted checks if all prompts with numbers less than n are in completed directory.
func Content ¶
Content returns the prompt content (without frontmatter) for passing to Docker. Returns ErrEmptyPrompt if the file is empty or contains only whitespace.
func HasExecuting ¶ added in v0.2.24
HasExecuting returns true if any prompt in dir has status "executing".
func MoveToCompleted ¶
MoveToCompleted sets status to "completed" and moves a prompt file to the completed directory. This ensures files in completed/ always have the correct status.
func ResetExecuting ¶ added in v0.2.5
ResetExecuting resets any prompts with status "executing" back to "queued". This handles prompts that got stuck from a previous crash.
func ResetFailed ¶ added in v0.10.6
ResetFailed resets any prompts with status "failed" back to "queued". This allows the factory to retry failed prompts after a restart.
func SetBranch ¶ added in v0.17.17
SetBranch updates the branch field in a prompt file's frontmatter. If the file has no frontmatter, adds frontmatter with the branch field.
func SetContainer ¶ added in v0.2.11
SetContainer updates the container field in a prompt file's frontmatter. If the file has no frontmatter, adds frontmatter with the container field.
func SetPRURL ¶ added in v0.16.0
SetPRURL updates the pr-url field in a prompt file's frontmatter. If the file has no frontmatter, adds frontmatter with the pr-url field.
func SetStatus ¶
SetStatus updates the status field in a prompt file's frontmatter. If the file has no frontmatter, adds frontmatter with the status field. Also sets appropriate timestamp fields based on status.
func SetVersion ¶ added in v0.6.0
SetVersion updates the dark-factory-version field in a prompt file's frontmatter. If the file has no frontmatter, adds frontmatter with the version field.
Types ¶
type Frontmatter ¶
type Frontmatter struct {
Status string `yaml:"status"`
Spec string `yaml:"spec,omitempty"`
Summary string `yaml:"summary,omitempty"`
Container string `yaml:"container,omitempty"`
DarkFactoryVersion string `yaml:"dark-factory-version,omitempty"`
Created string `yaml:"created,omitempty"`
Queued string `yaml:"queued,omitempty"`
Started string `yaml:"started,omitempty"`
Completed string `yaml:"completed,omitempty"`
PRURL string `yaml:"pr-url,omitempty"`
Branch string `yaml:"branch,omitempty"`
}
Frontmatter represents the YAML frontmatter in a prompt file.
func ReadFrontmatter ¶ added in v0.2.0
func ReadFrontmatter(ctx context.Context, path string) (*Frontmatter, error)
ReadFrontmatter reads frontmatter from a file.
type Manager ¶ added in v0.2.26
type Manager interface {
ResetExecuting(ctx context.Context) error
ResetFailed(ctx context.Context) error
HasExecuting(ctx context.Context) bool
ListQueued(ctx context.Context) ([]Prompt, error)
Load(ctx context.Context, path string) (*PromptFile, error)
ReadFrontmatter(ctx context.Context, path string) (*Frontmatter, error)
SetStatus(ctx context.Context, path string, status string) error
SetContainer(ctx context.Context, path string, name string) error
SetVersion(ctx context.Context, path string, version string) error
SetPRURL(ctx context.Context, path string, url string) error
SetBranch(ctx context.Context, path string, branch string) error
Content(ctx context.Context, path string) (string, error)
Title(ctx context.Context, path string) (string, error)
MoveToCompleted(ctx context.Context, path string) error
NormalizeFilenames(ctx context.Context, dir string) ([]Rename, error)
AllPreviousCompleted(ctx context.Context, n int) bool
}
Manager manages prompt file operations.
type Prompt ¶
Prompt represents a prompt file with YAML frontmatter.
func ListQueued ¶
ListQueued scans a directory for .md files that should be picked up. Files are picked up UNLESS they have an explicit skip status (executing, completed, failed). Sorted alphabetically by filename.
func (Prompt) Number ¶ added in v0.4.0
Number extracts the numeric prefix from the prompt filename. Returns -1 if the filename has no numeric prefix.
type PromptFile ¶ added in v0.11.6
type PromptFile struct {
Path string
Frontmatter Frontmatter
Body []byte // immutable after Load — never modified
// contains filtered or unexported fields
}
PromptFile represents a loaded prompt file with immutable body and mutable frontmatter.
func Load ¶ added in v0.11.6
func Load(ctx context.Context, path string) (*PromptFile, error)
Load reads a prompt file from disk, parsing frontmatter and body. Body is stored as-is and never modified by Save.
func (*PromptFile) Branch ¶ added in v0.17.17
func (pf *PromptFile) Branch() string
Branch returns the branch field from frontmatter.
func (*PromptFile) Content ¶ added in v0.11.6
func (pf *PromptFile) Content() (string, error)
Content returns the body as a string, stripped of leading empty frontmatter blocks. Returns ErrEmptyPrompt if body is empty or whitespace-only.
func (*PromptFile) MarkCompleted ¶ added in v0.11.6
func (pf *PromptFile) MarkCompleted()
MarkCompleted sets status to completed with timestamp.
func (*PromptFile) MarkFailed ¶ added in v0.11.6
func (pf *PromptFile) MarkFailed()
MarkFailed sets status to failed with timestamp.
func (*PromptFile) MarkQueued ¶ added in v0.11.6
func (pf *PromptFile) MarkQueued()
MarkQueued sets status to queued and ensures created/queued timestamps exist.
func (*PromptFile) PRURL ¶ added in v0.17.17
func (pf *PromptFile) PRURL() string
PRURL returns the pr-url field from frontmatter.
func (*PromptFile) PrepareForExecution ¶ added in v0.11.6
func (pf *PromptFile) PrepareForExecution(container, version string)
PrepareForExecution sets all fields needed before container launch. This replaces separate SetContainer + SetVersion + SetStatus calls.
func (*PromptFile) Save ¶ added in v0.11.6
func (pf *PromptFile) Save(ctx context.Context) error
Save writes the prompt file back to disk: frontmatter + body. Body is always preserved exactly as loaded.
func (*PromptFile) SetBranch ¶ added in v0.17.17
func (pf *PromptFile) SetBranch(branch string)
SetBranch sets the branch field in frontmatter.
func (*PromptFile) SetPRURL ¶ added in v0.16.0
func (pf *PromptFile) SetPRURL(url string)
SetPRURL sets the pr-url field in frontmatter.
func (*PromptFile) SetSummary ¶ added in v0.13.1
func (pf *PromptFile) SetSummary(summary string)
SetSummary sets the summary field in frontmatter.
func (*PromptFile) Title ¶ added in v0.11.6
func (pf *PromptFile) Title() string
Title extracts the first # heading from the body.
type Rename ¶ added in v0.2.15
Rename represents a file rename operation.
func NormalizeFilenames ¶ added in v0.2.15
func NormalizeFilenames( ctx context.Context, dir string, completedDir string, mover FileMover, ) ([]Rename, error)
NormalizeFilenames scans a directory for .md files and ensures they follow the NNN-slug.md naming convention. Files are renamed if they: - Have no numeric prefix (gets next available number) - Have a duplicate number (later file gets next available number) - Have wrong format (e.g., 9-foo.md instead of 009-foo.md) Returns list of renames performed.