Artifacts
Starting with Julia 1.6, the artifacts support has moved from Pkg.jl
to Julia itself. Until proper documentation can be added here, you can learn more about artifacts in the Pkg.jl
manual at https://julialang.github.io/Pkg.jl/v1/artifacts/.
Julia's artifacts API requires at least Julia 1.6. In Julia versions 1.3 to 1.5, you can use Pkg.Artifacts
instead.
Artifacts.artifact_meta
— Functionartifact_meta(name::String, artifacts_toml::String;
platform::AbstractPlatform = HostPlatform(),
pkg_uuid::Union{Base.UUID,Nothing}=nothing)
Get metadata about a given artifact (identified by name) stored within the given (Julia)Artifacts.toml
file. If the artifact is platform-specific, use platform
to choose the most appropriate mapping. If none is found, return nothing
.
Artifacts.artifact_hash
— FunctionArtifacts.find_artifacts_toml
— Functionfind_artifacts_toml(path::String)
Given the path to a .jl
file, (such as the one returned by __source__.file
in a macro context), find the (Julia)Artifacts.toml
that is contained within the containing project (if it exists), otherwise return nothing
.
Artifacts.@artifact_str
— Macromacro artifact_str(name)
Return the on-disk path to an artifact. Automatically looks the artifact up by name in the project's (Julia)Artifacts.toml
file. Throws an error on if the requested artifact is not present. If run in the REPL, searches for the toml file starting in the current directory, see find_artifacts_toml()
for more.
If the artifact is marked "lazy" and the package has using LazyArtifacts
defined, the artifact will be downloaded on-demand with Pkg
the first time this macro tries to compute the path. The files will then be left installed locally for later.
If name
contains a forward or backward slash, all elements after the first slash will be taken to be path names indexing into the artifact, allowing for an easy one-liner to access a single file/directory within an artifact. Example:
ffmpeg_path = @artifact"FFMPEG/bin/ffmpeg"
Artifacts.artifact_exists
— Functionartifact_exists(hash::SHA1; honor_overrides::Bool=true)
Return whether or not the given artifact (identified by its sha1 git tree hash) exists on-disk. Note that it is possible that the given artifact exists in multiple locations (e.g. within multiple depots).
Artifacts.artifact_path
— FunctionArtifacts.select_downloadable_artifacts
— Functionselect_downloadable_artifacts(artifacts_toml::String;
platform = HostPlatform,
include_lazy = false,
pkg_uuid = nothing)
Return a dictionary where every entry is an artifact from the given Artifacts.toml
that should be downloaded for the requested platform. Lazy artifacts are included if include_lazy
is set.