Versions in this module Expand all Collapse all v0 v0.2.124 Aug 15, 2026 Changes in this version + const ArtifactMediaType + const CompositionCatalogName + const CompositionInputName + const ContractComposition + const ContractFixtures + const ContractFrontendPlugin + const ContractPermissions + const ContractSettings + const DescriptorFileName + const DescriptorKind + const DevelopOverrideDirectory + const LockFileName + const LockSchema + const PackageKind + const PackageManifestFileName + const PackageSchema + const ProvenanceSchema + var DefaultSupportedContracts = map[string][]string + var ErrCacheVerification = errors.New("module cache verification failed") + var ErrCollision = errors.New("module composition collision") + var ErrContract = errors.New("module contract negotiation failed") + var ErrDigestMismatch = errors.New("module artifact digest mismatch") + var ErrMovedTag = errors.New("module release tag moved") + var ErrPackageIdentity = errors.New("module package identity mismatch") + var ErrSignature = errors.New("module provenance signature is invalid") + var ErrUnsafeArchive = errors.New("unsafe module archive") + func CanonicalArchive(root string) ([]byte, string, error) + func ClearDevelopOverride(projectRoot, module string) error + func CompositionDigest(moduleDir string, descriptor *Descriptor) (string, error) + func DecodeSignature(encoded []byte) ([]byte, error) + func ExtractArchive(ctx context.Context, archive []byte, destination string) error + func LockDiff(before, after *Lock) (string, error) + func MarshalLock(lock *Lock) ([]byte, error) + func NegotiateContracts(descriptor *Descriptor, manifest *PackageManifest, toolVersion string, ...) (map[string]string, error) + func ValidateCatalog(catalog *Catalog, expected []CatalogInput) error + func ValidateCollisions(claims []Claim, reservedNamespaces []string) error + func ValidateDevelopContracts(descriptor *Descriptor, manifest *PackageManifest, lock *Lock, ...) error + func ValidateLockedContracts(descriptor *Descriptor, manifest *PackageManifest, lock *Lock, ...) error + func WriteCanonicalArchive(root string, destination io.Writer) error + type ArtifactLock struct + Digest string + MediaType string + Signature string + type Base struct + ID string + Version string + type Binding struct + Alias string + Plugin string + Target BindingTarget + type BindingTarget struct + Module string + Service string + type Catalog struct + Claims []Claim + Dependencies []string + Inputs []CatalogInput + Schema string + func LoadCatalog(projection string) (*Catalog, error) + type CatalogInput struct + Digest string + Identity string + Kind string + Path string + func LoadContributionInputs(moduleDir string, descriptor *Descriptor) ([]CatalogInput, error) + type Claim struct + Key string + Kind CollisionKind + Owner string + type CollisionKind string + const CollisionMigration + const CollisionPackage + const CollisionPermission + const CollisionRoute + const CollisionServiceBinding + const CollisionSettingsField + const CollisionTopology + type CommandRunner interface + Run func(context.Context, CommandSpec) error + type CommandSpec struct + Command []string + Directory string + Env []string + Name string + type CompositionInput struct + ConsumerRoot string + Contracts map[string]string + Descriptor *Descriptor + Module string + Namespace *Namespace + Package string + Projection string + Schema string + Version string + type ContractChange struct + After string + Before string + Compatibility string + Contract string + type Contributions struct + Fixtures []PathContribution + Frontend []FrontendContribution + Permissions []PathContribution + Settings []SettingsContribution + Tests []IntegrationContribution + type Delta struct + Added []string + Removed []string + type Descriptor struct + Base Base + Bindings []Binding + Contributions Contributions + Kind string + Name string + Services Services + func LoadDescriptor(moduleDir string) (*Descriptor, error) + func (descriptor *Descriptor) Validate() error + type DevelopOverride struct + Contracts map[string]string + Module string + Package string + Schema string + Source string + func LoadDevelopOverride(projectRoot, module string) (*DevelopOverride, error) + func SetDevelopOverride(ctx context.Context, projectRoot, moduleDir, source string) (*DevelopOverride, error) + type DoctorCheck struct + Detail string + Name string + Status ValidationStatus + type Engine struct + Materializer *Materializer + ProjectRoot string + Renderer Renderer + Resolver Resolver + SupportedContracts map[string][]string + ToolVersion string + Trust TrustPolicy + func NewEngine(projectRoot string, resolver Resolver, trust TrustPolicy) *Engine + func (engine *Engine) Doctor(ctx context.Context, moduleDir string, ci bool) ([]DoctorCheck, error) + func (engine *Engine) Materialize(ctx context.Context, moduleDir string, options MaterializeOptions) (*Materialization, error) + func (engine *Engine) Rollback(ctx context.Context, moduleDir string, priorLock []byte) (*Materialization, error) + func (engine *Engine) Source(ctx context.Context, moduleDir string, options MaterializeOptions) (string, error) + func (engine *Engine) Update(ctx context.Context, moduleDir, targetVersion string, apply bool) (*UpdateResult, error) + type EntryPoint struct + Command []string + Name string + type ExecCommandRunner struct + func (ExecCommandRunner) Run(ctx context.Context, spec CommandSpec) error + type FrontendContribution struct + Export string + Path string + type GitHubPackage struct + ArtifactAsset string + Owner string + ProvenanceAsset string + RepositoryName string + RepositoryURL string + SignatureAsset string + type GitHubResolver struct + Client *github.Client + DownloadClient *http.Client + MaxArtifactBytes int64 + Packages map[string]GitHubPackage + func NewGitHubResolver(client *github.Client, downloadClient *http.Client, ...) *GitHubResolver + func (resolver *GitHubResolver) Fetch(ctx context.Context, lock *Lock) (*Release, error) + func (resolver *GitHubResolver) Resolve(ctx context.Context, request ResolveRequest) (*Release, error) + type IntegrationContribution struct + Command []string + Path string + type Lock struct + Artifact ArtifactLock + CompositionDigest string + Contracts map[string]string + Module string + Package string + Schema string + Source SourceLock + Version string + func LoadLock(moduleDir string) (*Lock, error) + func ParseLock(data []byte) (*Lock, error) + func (lock *Lock) Validate() error + type Materialization struct + Namespace *Namespace + Projection string + Source string + type MaterializeOptions struct + CI bool + LockPath string + Namespace string + type Materializer struct + MaxEntries int + MaxExpandedBytes int64 + Root string + func NewMaterializer(projectRoot string) *Materializer + func (materializer *Materializer) CachePath(digest string) (string, error) + func (materializer *Materializer) Cached(lock *Lock) (string, error) + func (materializer *Materializer) Materialize(ctx context.Context, release *VerifiedRelease) (string, error) + type Namespace struct + BuildDir string + CacheDir string + ContainerSuffix string + Digest string + LockPath string + Name string + NextJSDir string + PortSeed uint32 + ProjectionDir string + RuntimeConfigDir string + func ResolveNamespace(projectRoot, moduleDir, name, lockPath string, lock *Lock) (*Namespace, error) + func (namespace *Namespace) Prepare() error + type PackageCommand struct + Command []string + Name string + WorkingDirectory string + type PackageManifest struct + ArtifactRoots []string + BreakingChanges []string + Claims []Claim + Conformance []PackageCommand + Contracts map[string]string + EntryPoints []EntryPoint + Generators []PackageCommand + ID string + Kind string + Migrations []PackageMigration + MinimumCodeflyVersion string + ReservedNamespaces []string + Schema string + Services []ProvidedService + Version string + func LoadPackageManifest(root string) (*PackageManifest, error) + func (manifest *PackageManifest) Validate() error + type PackageMigration struct + Breaking bool + From string + ID string + type PathContribution struct + Path string + type Provenance struct + ArtifactDigest string + ArtifactMediaType string + Commit string + Package string + Ref string + Repository string + Schema string + SignatureIdentity string + Version string + func ParseProvenance(data []byte) (*Provenance, error) + type ProvidedService struct + Endpoints []string + Name string + type Release struct + Artifact []byte + Commit string + Provenance []byte + Ref string + Repository string + Signature []byte + type Renderer struct + Runner CommandRunner + func (renderer Renderer) Render(ctx context.Context, base, moduleDir, projection string, namespace *Namespace, ...) (*Catalog, []ValidationResult, error) + type ResolveRequest struct + Current *Lock + Package string + Version string + type Resolver interface + Fetch func(context.Context, *Lock) (*Release, error) + Resolve func(context.Context, ResolveRequest) (*Release, error) + type SemanticReport struct + AfterVersion string + BeforeVersion string + BlockedReasons []string + BreakingChanges []string + Contracts []ContractChange + Deltas map[CollisionKind]Delta + Dependencies Delta + Endpoints Delta + LockDiff string + Migrations Delta + Module string + Package string + Schema string + Services Delta + Validations []ValidationResult + func (report *SemanticReport) JSON() ([]byte, error) + func (report *SemanticReport) String() string + type Services struct + Include []string + type SettingsContribution struct + Message string + Path string + type SourceLock struct + Commit string + Ref string + Repository string + type TrustPolicy struct + Repositories map[string]string + Signers map[string]ed25519.PublicKey + type UpdateResult struct + Applied bool + Lock *Lock + Namespace *Namespace + Projection string + Report *SemanticReport + type V1BaseManifest struct + FileCount int + Files map[string]string + Note string + type V1BaseSource struct + Commit string + Ref string + Repository string + Schema string + Subdirectory string + type V1Bridge struct + Manifest *V1BaseManifest + Source *V1BaseSource + func LoadV1Bridge(moduleDir string) (*V1Bridge, error) + type V1MigrationClassification string + const V1MigrationBlocked + const V1MigrationContribution + const V1MigrationDrop + const V1MigrationGenerated + const V1MigrationUpstream + type V1MigrationEntry struct + Classification V1MigrationClassification + ConsumerDigest string + NewDigest string + OldDigest string + Path string + func PlanV1Migration(moduleDir, newBaseDir string, bridge *V1Bridge, ...) ([]V1MigrationEntry, error) + type ValidationResult struct + Detail string + Kind string + Name string + Status ValidationStatus + type ValidationStatus string + const ValidationFailed + const ValidationPassed + type VerifiedRelease struct + func VerifyLockedRelease(release *Release, lock *Lock, trust TrustPolicy) (*VerifiedRelease, error) + func VerifyRelease(release *Release, expectedPackage, expectedVersion string, trust TrustPolicy) (*VerifiedRelease, error)
Go to main page