Documentation

Lake.Build.Package

Package Facet Builds #

Build function definitions for a package's builtin facets.

source
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.
source
def Lake.Package.depsFacetConfig :
PackageFacetConfig depsFacet

The PackageFacetConfig for the builtin depsFacet.

Equations
source
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.
source
def Lake.Package.transDepsFacetConfig :
PackageFacetConfig transDepsFacet

The PackageFacetConfig for the builtin transDepsFacet.

Equations
source
def Lake.Package.optBuildCacheFacetConfig :
PackageFacetConfig optBuildCacheFacet

The PackageFacetConfig for the builtin optBuildCacheFacet.

Equations
source
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.
source
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.
source
@[deprecated Lake.Package.maybeFetchBuildCacheWithWarning (since := "2024-09-27")]
def Lake.Package.fetchOptRelease (self : Package) :
FetchM (Job PUnit)
Equations
source
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.
source
def Lake.Package.extraDepFacetConfig :
PackageFacetConfig extraDepFacet

The PackageFacetConfig for the builtin dynlibFacet.

Equations
source
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.
source
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.
source
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.
source
def Lake.Package.buildCacheFacetConfig :
PackageFacetConfig buildCacheFacet

The PackageFacetConfig for the builtin buildCacheFacet.

Equations
source
def Lake.Package.optBarrelFacetConfig :
PackageFacetConfig optReservoirBarrelFacet

The PackageFacetConfig for the builtin optReservoirBarrelFacet.

Equations
source
def Lake.Package.barrelFacetConfig :
PackageFacetConfig reservoirBarrelFacet

The PackageFacetConfig for the builtin reservoirBarrelFacet.

Equations
source
def Lake.Package.optGitHubReleaseFacetConfig :
PackageFacetConfig optGitHubReleaseFacet

The PackageFacetConfig for the builtin optGitHubReleaseFacet.

Equations
source
@[reducible, inline, deprecated Lake.Package.optGitHubReleaseFacetConfig (since := "2024-09-27")]
abbrev Lake.Package.optReleaseFacetConfig :
PackageFacetConfig optGitHubReleaseFacet
Equations
source
def Lake.Package.gitHubReleaseFacetConfig :
PackageFacetConfig gitHubReleaseFacet

The PackageFacetConfig for the builtin gitHubReleaseFacet.

Equations
source
@[reducible, inline, deprecated Lake.Package.gitHubReleaseFacetConfig (since := "2024-09-27")]
abbrev Lake.Package.releaseFacetConfig :
PackageFacetConfig gitHubReleaseFacet
Equations
source
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.
source
@[deprecated Lake.Package.afterBuildCacheAsync (since := "2024-09-27")]
def Lake.Package.afterReleaseAsync {α : Type} (self : Package) (build : JobM (Job α)) :
FetchM (Job α)
Equations
source
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.
source
@[deprecated Lake.Package.afterBuildCacheSync (since := "2024-09-27")]
def Lake.Package.afterReleaseSync {α : Type} (self : Package) (build : JobM α) :
FetchM (Job α)
Equations
source
def Lake.Package.initFacetConfigs :
DNameMap PackageFacetConfig

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

Equations
  • One or more equations did not get rendered due to their size.
source
@[reducible, inline]
abbrev Lake.initPackageFacetConfigs :
DNameMap PackageFacetConfig

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

Equations