Documentation

Lake.Build.Package

Package Facet Builds #

Build function definitions for a package's builtin facets.

source
def Lake.Package.recComputeDeps (self : Lake.Package) :
Lake.FetchM (Array Lake.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.depsFacetConfig :
Lake.PackageFacetConfig Lake.Package.depsFacet

The PackageFacetConfig for the builtin depsFacet.

Equations
source
def Lake.Package.optBuildCacheFacetConfig :
Lake.PackageFacetConfig Lake.Package.optBuildCacheFacet

The PackageFacetConfig for the builtin optBuildCacheFacet.

Equations
source
def Lake.Package.maybeFetchBuildCache (self : Lake.Package) :
Lake.FetchM (Lake.BuildJob 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 : Lake.Package) :
Lake.FetchM (Lake.Job (Unit × Lake.BuildTrace))

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]
def Lake.Package.fetchOptRelease (self : Lake.Package) :
Lake.FetchM (Lake.Job (Unit × Lake.BuildTrace))
Equations
source
def Lake.Package.recBuildExtraDepTargets (self : Lake.Package) :
Lake.FetchM (Lake.BuildJob Unit)

Build the extraDepTargets for the package and its transitive dependencies. Also fetch pre-built releases for the package's' dependencies.

Equations
  • One or more equations did not get rendered due to their size.
source
def Lake.Package.extraDepFacetConfig :
Lake.PackageFacetConfig Lake.Package.extraDepFacet

The PackageFacetConfig for the builtin dynlibFacet.

Equations
source
def Lake.Package.getBarrelUrl (self : Lake.Package) :
Lake.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 : Lake.Package) :
Lake.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 : Lake.Package) (url : String) (archiveFile : Lake.FilePath) (headers : optParam (Array String) #[]) :
Lake.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 :
Lake.PackageFacetConfig Lake.Package.buildCacheFacet

The PackageFacetConfig for the builtin buildCacheFacet.

Equations
source
def Lake.Package.optBarrelFacetConfig :
Lake.PackageFacetConfig Lake.Package.optReservoirBarrelFacet

The PackageFacetConfig for the builtin optReservoirBarrelFacet.

Equations
source
def Lake.Package.barrelFacetConfig :
Lake.PackageFacetConfig Lake.Package.reservoirBarrelFacet

The PackageFacetConfig for the builtin reservoirBarrelFacet.

Equations
source
def Lake.Package.optGitHubReleaseFacetConfig :
Lake.PackageFacetConfig Lake.Package.optGitHubReleaseFacet

The PackageFacetConfig for the builtin optGitHubReleaseFacet.

Equations
source
@[reducible, inline, deprecated]
abbrev Lake.Package.optReleaseFacetConfig :
Lake.PackageFacetConfig Lake.Package.optGitHubReleaseFacet
Equations
source
def Lake.Package.gitHubReleaseFacetConfig :
Lake.PackageFacetConfig Lake.Package.gitHubReleaseFacet

The PackageFacetConfig for the builtin gitHubReleaseFacet.

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