Documentation
¶
Overview ¶
Package generate obtains a resolved manifest from an executable project and installs generated artifacts atomically.
Index ¶
- func AdminPluginRegistry(manifest schema.Manifest) []byte
- func RunProjectMigration(ctx context.Context, definition projectfile.File, frameworkVersion string, ...) error
- type ArtifactResult
- type ResolvedProject
- func ResolveProject(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
- func ResolveProjectExecutable(ctx context.Context, definition projectfile.File, ...) (ResolvedProject, error)
- func ResolveProjectMetadata(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
- func ResolveProjectMetadataExecutable(ctx context.Context, definition projectfile.File, ...) (ResolvedProject, error)
- func ResolveProjectMetadataOffline(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
- type Result
- func Run(ctx context.Context, definition projectfile.File, frameworkVersion string, ...) (Result, error)
- func RunResolved(definition projectfile.File, manifest schema.Manifest, check bool) (Result, error)
- func RunResolvedDevelopment(definition projectfile.File, manifest schema.Manifest) (Result, error)
- func RunResolvedProject(definition projectfile.File, resolved ResolvedProject, check bool) (Result, error)
- func RunResolvedProjectDevelopment(definition projectfile.File, resolved ResolvedProject) (Result, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AdminPluginRegistry ¶
AdminPluginRegistry returns the generated static admin-plugin pairing module. It is exported from this internal package so maintained framework fixtures can byte-check the same artifact written for generated applications.
func RunProjectMigration ¶
func RunProjectMigration(ctx context.Context, definition projectfile.File, frameworkVersion string, request migration.ProjectRequest) error
RunProjectMigration delegates a callback-bearing lifecycle operation to the compiled project process so application functions and adapter schema work share one transaction.
Types ¶
type ArtifactResult ¶
ArtifactResult describes one checked or installed generated file.
type ResolvedProject ¶
type ResolvedProject struct {
Manifest schema.Manifest
PluginArtifacts []project.Artifact
DataTransforms []migration.DataTransformDescriptor
}
ResolvedProject is one executable project snapshot used by every artifact in a generation run. PluginArtifacts are produced inside the compiled project so executable plugin options never need to enter the manifest.
func ResolveProject ¶
func ResolveProject(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
ResolveProject obtains the manifest and exact executable-plugin artifacts through the versioned project generation command.
func ResolveProjectExecutable ¶
func ResolveProjectExecutable(ctx context.Context, definition projectfile.File, frameworkVersion, executable string) (ResolvedProject, error)
ResolveProjectExecutable obtains one generation snapshot from an already compiled project executable.
func ResolveProjectMetadata ¶
func ResolveProjectMetadata(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
ResolveProjectMetadata obtains the current canonical manifest and migration metadata without asking plugins to generate unrelated artifacts.
func ResolveProjectMetadataExecutable ¶
func ResolveProjectMetadataExecutable(ctx context.Context, definition projectfile.File, frameworkVersion, executable string) (ResolvedProject, error)
ResolveProjectMetadataExecutable obtains the canonical manifest and migration metadata from one already compiled project executable. The executable still enters the same private, versioned project protocol as ordinary generation.
func ResolveProjectMetadataOffline ¶
func ResolveProjectMetadataOffline(ctx context.Context, definition projectfile.File, frameworkVersion string) (ResolvedProject, error)
ResolveProjectMetadataOffline obtains migration-planning metadata without forwarding Ridu's supported database connection or path variables to the compiled child. Offline planning does not need them, and a failing child must not be able to copy their values into its diagnostics.
type Result ¶
type Result struct {
Artifacts []ArtifactResult
Warnings []string
// Manifest is the executable schema used for every generated artifact in
// this run. Release checks use the same resolved value to prove migration
// history without invoking the project protocol a second time.
Manifest schema.Manifest
}
Result describes one generation or drift-check run.
func Run ¶
func Run(ctx context.Context, definition projectfile.File, frameworkVersion string, check bool) (Result, error)
Run resolves executable config through the project protocol and writes or checks the canonical schema artifact.
func RunResolved ¶
RunResolved generates project artifacts from a manifest already obtained through the versioned executable project protocol. Development uses this to build once, resolve the candidate binary, and start that same binary.
func RunResolvedDevelopment ¶
RunResolvedDevelopment atomically generates project artifacts without forcing each disposable intermediate file to stable storage. A rename still exposes only a complete old or new artifact; ordinary generation retains the stronger per-file durability boundary used by review and release workflows.
func RunResolvedProject ¶
func RunResolvedProject(definition projectfile.File, resolved ResolvedProject, check bool) (Result, error)
RunResolvedProject installs artifacts from one already-resolved executable project response.
func RunResolvedProjectDevelopment ¶
func RunResolvedProjectDevelopment(definition projectfile.File, resolved ResolvedProject) (Result, error)
RunResolvedProjectDevelopment installs one executable project response with development durability while retaining atomic visibility.
Source Files