Package Facet Builds

Build function definitions for a package's builtin facets.

def Lake.Package.recFetchDeps (self : Package) : FetchM (Job (Array Package))

Fetch the package's direct dependencies.

def Lake.Package.depsFacetConfig : PackageFacetConfig depsFacet

The PackageFacetConfig for the builtin depsFacet.

def Lake.Package.recComputeTransDeps (self : Package) : FetchM (Job (Array Package))

Compute a topological ordering of the package's transitive dependencies.

def Lake.Package.transDepsFacetConfig : PackageFacetConfig transDepsFacet

The PackageFacetConfig for the builtin transDepsFacet.

def Lake.Package.optBuildCacheFacetConfig : PackageFacetConfig optBuildCacheFacet

The PackageFacetConfig for the builtin optBuildCacheFacet.

def Lake.Package.maybeFetchBuildCache (self : Package) : FetchM (Job Bool)

Tries to download the package's build cache (if configured).

def Lake.Package.maybeFetchBuildCacheWithWarning (self : Package) : FetchM (Job PUnit)

Tries to download and unpack the package's cached build archive (e.g., from Reservoir or GitHub). Prints a warning on failure.

def Lake.Package.recBuildExtraDepTargets (self : Package) : FetchM (Job Unit)

Build the extraDepTargets for the package. Also, if the package is a dependency, maybe fetch its build cache.

def Lake.Package.extraDepFacetConfig : PackageFacetConfig extraDepFacet

The PackageFacetConfig for the builtin dynlibFacet.

def Lake.Package.getBarrelUrl (self : Package) : JobM String

Compute the package's Reservoir barrel URL.

def Lake.Package.getReleaseUrl (self : Package) : JobM String

Compute the package's GitHub release URL.

def Lake.Package.fetchBuildArchive (self : Package) (url : String) (archiveFile : System.FilePath) (headers : Array String := #[]) : JobM PUnit

Tries to download and unpack a build archive for the package from a URL.

def Lake.Package.buildCacheFacetConfig : PackageFacetConfig buildCacheFacet

The PackageFacetConfig for the builtin buildCacheFacet.

def Lake.Package.optBarrelFacetConfig : PackageFacetConfig optReservoirBarrelFacet

The PackageFacetConfig for the builtin optReservoirBarrelFacet.

def Lake.Package.barrelFacetConfig : PackageFacetConfig reservoirBarrelFacet

The PackageFacetConfig for the builtin reservoirBarrelFacet.

def Lake.Package.optGitHubReleaseFacetConfig : PackageFacetConfig optGitHubReleaseFacet

The PackageFacetConfig for the builtin optGitHubReleaseFacet.

def Lake.Package.gitHubReleaseFacetConfig : PackageFacetConfig gitHubReleaseFacet

The PackageFacetConfig for the builtin gitHubReleaseFacet.

def Lake.Package.afterBuildCacheAsync {α : Type} (self : Package) (build : JobM (Job α)) : FetchM (Job α)

Perform a build job after first checking for an (optional) cached build for the package (e.g., from Reservoir or GitHub).

def Lake.Package.afterBuildCacheSync {α : Type} (self : Package) (build : JobM α) : FetchM (Job α)

Perform a build after first checking for an (optional) cached build for the package (e.g., from Reservoir or GitHub).

def Lake.Package.initFacetConfigs : DNameMap PackageFacetConfig

A name-configuration map for the initial set of Lake package facets (e.g., extraDep).

@[reducible, inline]

abbrev Lake.initPackageFacetConfigs : DNameMap PackageFacetConfig

A name-configuration map for the initial set of Lake package facets (e.g., extraDep).