Multiversion bundle config support

.github/workflows/CI.yml

@@ -19,112 +19,142 @@ permissions:
   contents: read
 
 jobs:
-  finalize:
-    timeout-minutes: 10
-    needs: [test-bundle]
-    if: always()
+  # finalize:
+  #   timeout-minutes: 10
+  #   needs: [test-bundle]
+  #   if: always()
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - run: |
+  #         echo test: ${{ needs.test-bundle.result }}
+  #     - run: exit 1
+  #       if: |
+  #         (needs.test-bundle.result != 'success')
+
+  multiversion-build:
     runs-on: ubuntu-latest
-    steps:
-      - run: |
-          echo test: ${{ needs.test-bundle.result }}
-      - run: exit 1
-        if: |
-          (needs.test-bundle.result != 'success')
-
-  test:
-    runs-on: ${{ matrix.os }}
     timeout-minutes: 60
-    strategy:
-      fail-fast: false
-      matrix:
-        version:
-          - "1.10"
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - windows-latest
-
     steps:
       - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
         with:
           persist-credentials: false
-      - uses: julia-actions/setup-julia@f2258781c657ad9b4b88072c5eeaf9ec8c370874
-        with:
-          version: ${{ matrix.version }}
-      - uses: julia-actions/cache@dc1a3cdeacb521b0ca93cfc66143fcadb15a5bd0
-      - uses: julia-actions/julia-buildpkg@90dd6f23eb49626e4e6612cb9d64d456f86e6a1c
-
-      # `PackageBundler.bundle()` expects the environments to be bundled to have
-      # already been instantiated (hence downloaded) prior to running it. We
-      # don't need to precompile it though.
-      - run: julia --project=test/envs/CustomEnv -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.instantiate()'
-
-      - uses: julia-actions/julia-runtest@79a7e100883947123f8263c5f06e6c0ea3eb972f
-      - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3
-        with:
-          name: bundle-${{ matrix.os }}
-          path: test/build/LocalCustomRegistry
 
-  test-bundle:
-    needs: [test]
-    runs-on: ${{ matrix.os }}
-    timeout-minutes: 60
-    strategy:
-      fail-fast: false
-      matrix:
-        version:
-          - "1.10"
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - windows-latest
-        bundle:
-          - bundle-macos-latest
-          - bundle-ubuntu-latest
-          - bundle-windows-latest
-
-    steps:
-      - uses: julia-actions/setup-julia@f2258781c657ad9b4b88072c5eeaf9ec8c370874
-        with:
-          version: ${{ matrix.version }}
-
-      - uses: julia-actions/cache@dc1a3cdeacb521b0ca93cfc66143fcadb15a5bd0
-
-      - uses: actions/download-artifact@c850b930e6ba138125429b7e5c93fc707a7f8427
-        with:
-          name: ${{ matrix.bundle }}
-          path: ${{ matrix.bundle }}
-
-      - name: Initialize Julia Depot
-        run: julia -e 'import Pkg; Pkg.status()'
-
-      - name: Install bundle
-        run: julia ${{ matrix.bundle }}/registry/install.jl
-
-      - name: Installing the same bundle again should uninstall and reinstall
-        run: julia ${{ matrix.bundle }}/registry/install.jl
-
-      - name: Resolve environment and precompile
-        run: |
-          julia --project=@CustomEnv -e '
-            pushfirst!(LOAD_PATH, "@stdlib")
-            import Pkg
-            Pkg.status()
-            Pkg.resolve()
-            Pkg.precompile("CairoMakie")
-          '
-
-      - name: Load packages
-        run: julia --project=@CustomEnv -e 'import CairoMakie'
-
-      - name: Remove bundle
-        run: |
-          julia -e '
-            for depot in DEPOT_PATH
-              path = joinpath(depot, "registries", "LocalCustomRegistry", "remove.jl")
-              if isfile(path)
-                run(`julia $path`)
-                break
-              end
-            end
-          '
+      - uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
+      - run: |
+          asdf plugin-add julia
+          asdf install julia 1.10.1
+          asdf install julia 1.10.2
+
+      - run: julia --project=test/multiversion/envs/CommonMark_1.10.1 -e 'import Pkg; Pkg.instantiate()'
+        env:
+          ASDF_JULIA_VERSION: "1.10.1"
+
+      - run: julia --project=test/multiversion/envs/CommonMark_1.10.2 -e 'import Pkg; Pkg.instantiate()'
+        env:
+          ASDF_JULIA_VERSION: "1.10.2"
+
+      - run: julia --project -e 'import Pkg; Pkg.instantiate()'
+        env:
+          ASDF_JULIA_VERSION: "1.10.2"
+
+      - run: asdf global julia 1.10.2
+
+      - run: julia --project test/multiversion/bundle.jl
+
+  # test:
+  #   runs-on: ${{ matrix.os }}
+  #   timeout-minutes: 60
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       version:
+  #         - "1.10"
+  #       os:
+  #         - macos-latest
+  #         - ubuntu-latest
+  #         - windows-latest
+
+  #   steps:
+  #     - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633
+  #       with:
+  #         persist-credentials: false
+  #     - uses: julia-actions/setup-julia@f2258781c657ad9b4b88072c5eeaf9ec8c370874
+  #       with:
+  #         version: ${{ matrix.version }}
+  #     - uses: julia-actions/cache@dc1a3cdeacb521b0ca93cfc66143fcadb15a5bd0
+  #     - uses: julia-actions/julia-buildpkg@90dd6f23eb49626e4e6612cb9d64d456f86e6a1c
+
+  #     # `PackageBundler.bundle()` expects the environments to be bundled to have
+  #     # already been instantiated (hence downloaded) prior to running it. We
+  #     # don't need to precompile it though.
+  #     - run: julia --project=test/envs/CustomEnv -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.instantiate()'
+
+  #     - uses: julia-actions/julia-runtest@79a7e100883947123f8263c5f06e6c0ea3eb972f
+  #     - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3
+  #       with:
+  #         name: bundle-${{ matrix.os }}
+  #         path: test/build/LocalCustomRegistry
+
+  # test-bundle:
+  #   needs: [test]
+  #   runs-on: ${{ matrix.os }}
+  #   timeout-minutes: 60
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       version:
+  #         - "1.10"
+  #       os:
+  #         - macos-latest
+  #         - ubuntu-latest
+  #         - windows-latest
+  #       bundle:
+  #         - bundle-macos-latest
+  #         - bundle-ubuntu-latest
+  #         - bundle-windows-latest
+
+  #   steps:
+  #     - uses: julia-actions/setup-julia@f2258781c657ad9b4b88072c5eeaf9ec8c370874
+  #       with:
+  #         version: ${{ matrix.version }}
+
+  #     - uses: julia-actions/cache@dc1a3cdeacb521b0ca93cfc66143fcadb15a5bd0
+
+  #     - uses: actions/download-artifact@c850b930e6ba138125429b7e5c93fc707a7f8427
+  #       with:
+  #         name: ${{ matrix.bundle }}
+  #         path: ${{ matrix.bundle }}
+
+  #     - name: Initialize Julia Depot
+  #       run: julia -e 'import Pkg; Pkg.status()'
+
+  #     - name: Install bundle
+  #       run: julia ${{ matrix.bundle }}/registry/install.jl
+
+  #     - name: Installing the same bundle again should uninstall and reinstall
+  #       run: julia ${{ matrix.bundle }}/registry/install.jl
+
+  #     - name: Resolve environment and precompile
+  #       run: |
+  #         julia --project=@CustomEnv -e '
+  #           pushfirst!(LOAD_PATH, "@stdlib")
+  #           import Pkg
+  #           Pkg.status()
+  #           Pkg.resolve()
+  #           Pkg.precompile("CairoMakie")
+  #         '
+
+  #     - name: Load packages
+  #       run: julia --project=@CustomEnv -e 'import CairoMakie'
+
+  #     - name: Remove bundle
+  #       run: |
+  #         julia -e '
+  #           for depot in DEPOT_PATH
+  #             path = joinpath(depot, "registries", "LocalCustomRegistry", "remove.jl")
+  #             if isfile(path)
+  #               run(`julia $path`)
+  #               break
+  #             end
+  #           end
+  #         '

.gitignore

@@ -3,4 +3,5 @@
 *.pem
 *.pub
 test/build
+test/multiversion/build
 .DS_Store

src/PackageBundler.jl

@@ -154,7 +154,7 @@ function bundle(
 
     # Multiplexer. The environment variable used by the Julia version multiplexer
     # to select the version of `julia` to run.
-    multiplexer = get(config, "multiplexer", "")::String
+    multiplexers = String.(get(Vector{String}, config, "multiplexers"))
 
     mktempdir() do temp_dir
         # Generate the bundle in a temp directory, afterwhich copy the result
@@ -167,7 +167,7 @@ function bundle(
             uuid = uuid,
             key_pair = (; private, public),
             handlers = handlers,
-            multiplexer = multiplexer,
+            multiplexers = multiplexers,
         )
         for output in outputs
             output = normpath(joinpath(dir, output))

src/code_stripping.jl

@@ -8,7 +8,7 @@ function _generate_stripped_bundle(;
     uuid::Union{AbstractString,Integer,Base.UUID},
     key_pair::@NamedTuple{private::String, public::String},
     handlers::Dict,
-    multiplexer::String,
+    multiplexers::Vector{String},
 )
     output_dir = abspath(output_dir)
 
@@ -27,7 +27,7 @@ function _generate_stripped_bundle(;
             stripped = stripped,
             key_pair = key_pair,
             handlers = handlers,
-            multiplexer = multiplexer,
+            multiplexers = multiplexers,
         )
 
         stripped_uuid_mapping = merge(stripped_uuid_mapping, new_stripped_uuid_mapping)
@@ -255,7 +255,7 @@ function _process_project_env(;
     stripped::Dict{String,String},
     key_pair::@NamedTuple{private::String, public::String},
     handlers::Dict,
-    multiplexer::String,
+    multiplexers::Vector{String},
 )
     project_dir = normpath(project_dir)
     output_dir = normpath(output_dir)
@@ -301,7 +301,7 @@ function _process_project_env(;
                 stripped_pkg_uuid_mapping,
                 key_pair,
                 handlers,
-                multiplexer,
+                multiplexers,
             )
             versions = get!(Dict{String,Any}, pkg_version_info, each_name)
             versions[version_info["project"]["version"]] = version_info
@@ -478,7 +478,7 @@ function _strip_package(
     uuid_replacements::Dict,
     key_pair::@NamedTuple{private::String, public::String},
     handlers::Dict,
-    multiplexer::String,
+    multiplexers::Vector{String},
 )
     @info "Stripping source code." package
 
@@ -588,10 +588,8 @@ function _strip_package(
                 TOML.print(io, Dict("julia_files" => julia_files, "handlers" => handlers))
             end
             script = joinpath(@__DIR__, "serializer.jl")
-            envs = isempty(multiplexer) ? [] : [multiplexer => "$julia_version"]
-            withenv(envs...) do
-                run(`$(Base.julia_exename()) --startup-file=no $(script) $(toml_file)`)
-            end
+            binary = _process_multiplexers(multiplexers, julia_version)
+            run(`$(binary) --startup-file=no $(script) $(toml_file)`)
         end
 
         # Sign all the files that have been created/modified during serialization.
@@ -632,3 +630,31 @@ function _stripped_source_path(
     project_root = dirname(project_toml)
     return joinpath("[bundled]", package_name, version, relpath(source_file, project_root))
 end
+
+function _process_multiplexers(multiplexers::Vector{String}, julia_version::VersionNumber)
+    for multiplexer in multiplexers
+        exists = Sys.which(multiplexer)
+        if !isnothing(exists)
+            if multiplexer == "juliaup"
+                return `julia +$(julia_version)`
+            elseif multiplexer == "asdf"
+                return withenv("ASDF_JULIA_VERSION" => "$(julia_version)") do
+                    path = readchomp(`asdf which julia`)
+                    return `$(path)`
+                end
+            elseif multiplexer == "mise"
+                return withenv("MISE_JULIA_VERSION" => "$(julia_version)") do
+                    path = readchomp(`mise which julia`)
+                    return `$(path)`
+                end
+            else
+                error("Unsupported multiplexer: $multiplexer")
+            end
+        end
+    end
+    if isempty(multiplexers)
+        return Base.julia_cmd()
+    else
+        error("no multiplexers found: $(repr(multiplexers))")
+    end
+end

test/multiversion/PackageBundler.toml

@@ -0,0 +1,13 @@
+name = "CommonMarkStrippedRegistry"
+uuid = "a0e467e0-faf1-11e4-9d3f-2f4b262e6b06"
+environments = [
+    "envs/CommonMark_1.10.2",
+    "envs/CommonMark_1.10.1"
+]
+outputs = ["build/LocalCustomRegistry"]
+key = "key"
+clean = true
+multiplexers = ["asdf", "juliaup"]
+
+[packages]
+"a80b9123-70ca-4bc0-993e-6e3bcb318db6" = "CommonMark"

test/multiversion/bundle.jl

@@ -0,0 +1,6 @@
+import PackageBundler
+
+cd(@__DIR__) do
+    PackageBundler.keypair()
+    PackageBundler.bundle()
+end