This repository contains example configuration for consuming a package bundler artifact generated via PackageBundler.jl.

[!TIP]

You need to have juliaup installed to be able to continue with this guide.

To install the bundled packages and environments that this package provides run the following:

[!IMPORTANT]

Windows Powershell

Copy and run the below code in a terminal:

julia --startup-file=no --project=@PackageBundlerProviderExample -e '
  import Pkg;
  Pkg.add(; url = \"https://github.com/MichaelHatherly/package-bundler-provider-example\");
  import PackageBundlerProviderExample;
  PackageBundlerProviderExample.install()
'

macOS and Linux Shells

Copy and run the below code in a terminal:

julia --startup-file=no --project=@PackageBundlerProviderExample -e '
  import Pkg;
  Pkg.add(; url = "https://github.com/MichaelHatherly/package-bundler-provider-example");
  import PackageBundlerProviderExample;
  PackageBundlerProviderExample.install()
'

To update the bundled packages and environments that this package provides run the following:

julia --startup-file=no --project=@PackageBundlerProviderExample -e '
  import Pkg;
  Pkg.update();
  import PackageBundlerProviderExample;
  PackageBundlerProviderExample.install()
'

The installation above adds several global environments to your Julia depot. These can be used via the --project=@ syntax as follows:

julia --project=@bundled@v1.1.0

[!WARNING]

Each bundled environment requires a specific julia version. Make sure to run julia with the correct channel, e.g.

julia +1.10.1 --project=@bundled@v1.0.0

Bundled environments should be considered read-only. If you need to make changes to the environment, such as adding extra packages that are not included by default in a project's dependencies, you should copy the environment to a new location and make changes there using the copy function:

julia --project=@PackageBundlerProviderExample

julia> import PackageBundlerProviderExample

julia> PackageBundlerProviderExample.copy("bundled@v1.1.0", "my/custom/env")

Afterwards, you can use the copied environment as you would any other environment:

julia --project=my/custom/env

julia> ] add Some Extra Packages

Note that the included compat bounds in the Project.toml of the copied environment may restrict what versions of extra packages you are be able to add.

A juliaup override is applied to the copied environment's directory to ensure that the correct julia version is used when activating the environment regardless of what the user's default julia version is.

To remove the bundled packages and their environments run the following:

julia --startup-file=no --project=@PackageBundlerProviderExample -e '
  import PackageBundlerProviderExample;
  PackageBundlerProviderExample.remove()
'