Minimal working example

[stemann]

I'm trying out PackageBundler, and I'm not completely sure I'm getting the proper output in build.

Should the following instructions yield a MWE? The following MWE might be useful.

1. Generate a PackageBundler project in ExampleBundle:

julia --eval '
  import Pkg
  Pkg.activate(; temp = true)
  Pkg.add(; url = "https://github.com/PumasAI/PackageBundler.jl")
  import PackageBundler
  PackageBundler.generate(joinpath(pwd(), "ExampleBundle"))
'

2. Generate an environment in ExampleBundle/environments/ExampleEnv (Serialization is required to be in env.):

cd ExampleBundle

mkdir -p environments/ExampleEnv

cat <<EOT > environments/ExampleEnv/Project.toml
[deps]
Example = "7876af07-990d-54b4-ab0e-23690620f79a"
Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
EOT

julia --project=environments/ExampleEnv --eval '
  using Pkg
  Pkg.instantiate()
'

3. Adapt the generated ExampleBundle/PackageBundler.toml to strip code from Example from General:

cat <<EOT > PackageBundler.toml
name = "ExampleBundle"
uuid = "f3c4f87b-1a1f-6f7f-c170-8f556c78b68b"
environments = [
    "environments/ExampleEnv",
]
outputs = ["build"]
key = "key"
clean = true
multiplexers = ["juliaup", "asdf"]

# Registries that you want to strip code from.
# [registries]

# Packages that you want to strip code from.
[packages]
"7876af07-990d-54b4-ab0e-23690620f79a" = "Example"
EOT

4. Generate keys:

julia --project --eval '
  import PackageBundler
  PackageBundler.keypair(pwd())
'

5. Bundle ExampleBundle (ExampleEnv) into build:

julia --project bundle.jl

[stemann]

I only get the following in build:

$ ls -laR build/
total 0
drwxr-xr-x   4 jesper  staff  128 Jun 25 14:36 .
drwxr-xr-x  12 jesper  staff  384 Jun 25 14:36 ..
drwxr-xr-x   3 jesper  staff   96 Jun 25 14:36 environments
drwxr-xr-x   5 jesper  staff  160 Jun 25 14:36 registry

build//environments:
total 0
drwxr-xr-x  3 jesper  staff   96 Jun 25 14:36 .
drwxr-xr-x  4 jesper  staff  128 Jun 25 14:36 ..
drwxr-xr-x  7 jesper  staff  224 Jun 25 14:36 ExampleEnv

build//environments/ExampleEnv:
total 40
drwxr-xr-x  7 jesper  staff  224 Jun 25 14:36 .
drwxr-xr-x  3 jesper  staff   96 Jun 25 14:36 ..
-rw-r--r--  1 jesper  staff  337 Jun 25 14:36 Manifest.toml
-rw-r--r--  1 jesper  staff  512 Jun 25 14:36 Manifest.toml.sign
-rw-r--r--  1 jesper  staff  197 Jun 25 14:36 Project.toml
-rw-r--r--  1 jesper  staff  512 Jun 25 14:36 Project.toml.sign
-rw-r--r--  1 jesper  staff  799 Jun 25 14:36 key.pub

build//registry:
total 48
drwxr-xr-x  5 jesper  staff    160 Jun 25 14:36 .
drwxr-xr-x  4 jesper  staff    128 Jun 25 14:36 ..
-rw-r--r--  1 jesper  staff    125 Jun 25 14:36 Registry.toml
-rw-r--r--  1 jesper  staff  16198 Jun 25 14:36 install.jl
-rw-r--r--  1 jesper  staff   1258 Jun 25 14:36 remove.jl

[MichaelHatherly]

Hey, see https://github.com/PumasAI/PackageBundler.jl/blob/main/test/PackageBundler.toml for an example. Note that [packages] needs to be inverted, so:

[packages]
"7876af07-990d-54b4-ab0e-23690620f79a" = "Example"

Avoid having a [registries] entry unless you want to strip code from every package in that listed registry.

Hope that helps, if not let me know.

[stemann]

Thanks! That did the trick :-)

[stemann]

... except I did not expect to see the source code of Example.jl when trying to use the registry and environment in build, but I guess it is the de-duplication of packages preferring source-available versions from General etc.? (cf. https://github.com/PumasAI/PackageBundler.jl/blob/main/src/install.jl#L131-L170

ExampleBundle$ docker run -it --rm -v $(pwd)/build:/build -w /build julia bash

root@00985c216a54:/build# julia registry/install.jl 

┌ Warning: `juliaup` is not installed. Some functionality may be limited.
└ @ Main /build/registry/install.jl:18
       Added `General` registry to ~/.julia/registries
┌ Info: Installing environments
│   new_environments =
│    1-element Vector{String}:
└     "ExampleEnv"
[ Info: Linking bundled packages
┌ Info: Skipping duplicate package versions.
│   registry = "General"
│   package = "Example"
└   versions = "0.5.5"
     Copying registry from `/tmp/jl_reZpuy`
      Copied registry `ExampleBundle` to `~/.julia/registries/ExampleBundle`

root@00985c216a54:/build# julia --project=environments/ExampleEnv --eval 'using Pkg; Pkg.instantiate(); using Example; print(read(pathof(Example), String))'

   Installed Example ─ v0.5.5
Precompiling project...
  1 dependency successfully precompiled in 1 seconds. 1 already precompiled.

module Example
export hello, domath

"""
    hello(who::String)

Return "Hello, `who`".
"""
hello(who::String) = "Hello, $who"

"""
    domath(x::Number)

Return `x + 5`.
"""
domath(x::Number) = x + 5

end