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.

Equations

• One or more equations did not get rendered due to their size.

def Lake.Package.depsFacetConfig : PackageFacetConfig depsFacet

The PackageFacetConfig for the builtin depsFacet.

Equations

• Lake.Package.depsFacetConfig = Lake.mkFacetJobConfig Lake.Package.recFetchDeps false

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

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

Equations

• One or more equations did not get rendered due to their size.

def Lake.Package.transDepsFacetConfig : PackageFacetConfig transDepsFacet

The PackageFacetConfig for the builtin transDepsFacet.

Equations

• Lake.Package.transDepsFacetConfig = Lake.mkFacetJobConfig Lake.Package.recComputeTransDeps false

def Lake.Package.optBuildCacheFacetConfig : PackageFacetConfig optBuildCacheFacet

The PackageFacetConfig for the builtin optBuildCacheFacet.

Equations

• Lake.Package.optBuildCacheFacetConfig = Lake.mkFacetJobConfig fun (x : Lake.Package) => Lake.Package.fetchOptBuildCacheCore✝ x

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

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

Equations

• One or more equations did not get rendered due to their size.

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.

Equations

• One or more equations did not get rendered due to their size.

@[deprecated Lake.Package.maybeFetchBuildCacheWithWarning (since := "2024-09-27")]

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

Equations

• Lake.Package.fetchOptRelease = Lake.Package.maybeFetchBuildCacheWithWarning

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.

Equations

• One or more equations did not get rendered due to their size.

def Lake.Package.extraDepFacetConfig : PackageFacetConfig extraDepFacet

The PackageFacetConfig for the builtin dynlibFacet.

Equations

• Lake.Package.extraDepFacetConfig = Lake.mkFacetJobConfig Lake.Package.recBuildExtraDepTargets

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

Compute the package's Reservoir barrel URL.

Equations

• One or more equations did not get rendered due to their size.

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

Compute the package's GitHub release URL.

Equations

• One or more equations did not get rendered due to their size.

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.

Equations

• One or more equations did not get rendered due to their size.

def Lake.Package.buildCacheFacetConfig : PackageFacetConfig buildCacheFacet

The PackageFacetConfig for the builtin buildCacheFacet.

Equations

• Lake.Package.buildCacheFacetConfig = Lake.Package.mkBuildArchiveFacetConfig✝ Lake.Package.optBuildCacheFacet "build cache"

def Lake.Package.optBarrelFacetConfig : PackageFacetConfig optReservoirBarrelFacet

The PackageFacetConfig for the builtin optReservoirBarrelFacet.

Equations

• Lake.Package.optBarrelFacetConfig = Lake.Package.mkOptBuildArchiveFacetConfig✝ Lake.Package.barrelFile Lake.Package.getBarrelUrl Lake.Reservoir.lakeHeaders

def Lake.Package.barrelFacetConfig : PackageFacetConfig reservoirBarrelFacet

The PackageFacetConfig for the builtin reservoirBarrelFacet.

Equations

• Lake.Package.barrelFacetConfig = Lake.Package.mkBuildArchiveFacetConfig✝ Lake.Package.optReservoirBarrelFacet "Reservoir build"

def Lake.Package.optGitHubReleaseFacetConfig : PackageFacetConfig optGitHubReleaseFacet

The PackageFacetConfig for the builtin optGitHubReleaseFacet.

Equations

• Lake.Package.optGitHubReleaseFacetConfig = Lake.Package.mkOptBuildArchiveFacetConfig✝ Lake.Package.buildArchiveFile Lake.Package.getReleaseUrl #[]

@[reducible, inline, deprecated Lake.Package.optGitHubReleaseFacetConfig (since := "2024-09-27")]

abbrev Lake.Package.optReleaseFacetConfig : PackageFacetConfig optGitHubReleaseFacet

Equations

• Lake.Package.optReleaseFacetConfig = Lake.Package.optGitHubReleaseFacetConfig

def Lake.Package.gitHubReleaseFacetConfig : PackageFacetConfig gitHubReleaseFacet

The PackageFacetConfig for the builtin gitHubReleaseFacet.

Equations

• Lake.Package.gitHubReleaseFacetConfig = Lake.Package.mkBuildArchiveFacetConfig✝ Lake.Package.optGitHubReleaseFacet "GitHub release"

@[reducible, inline, deprecated Lake.Package.gitHubReleaseFacetConfig (since := "2024-09-27")]

abbrev Lake.Package.releaseFacetConfig : PackageFacetConfig gitHubReleaseFacet

Equations

• Lake.Package.releaseFacetConfig = Lake.Package.gitHubReleaseFacetConfig

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).

Equations

• One or more equations did not get rendered due to their size.

@[deprecated Lake.Package.afterBuildCacheAsync (since := "2024-09-27")]

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

Equations

• @Lake.Package.afterReleaseAsync = @Lake.Package.afterBuildCacheAsync

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).

Equations

• One or more equations did not get rendered due to their size.

@[deprecated Lake.Package.afterBuildCacheSync (since := "2024-09-27")]

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

Equations

• @Lake.Package.afterReleaseSync = @Lake.Package.afterBuildCacheSync

def Lake.initPackageFacetConfigs : DNameMap PackageFacetConfig

A package facet name to build function map that contains builders for the initial set of Lake package facets (e.g., extraDep).

Equations

• One or more equations did not get rendered due to their size.