Add private registry capability

README.md

@@ -188,6 +188,39 @@ SimpleContainerGenerator.create_dockerfile(pkgs;
 run(`docker build -t my_docker_username/my_image_name .`)
 ```
 
+### Example 8
+
+```julia
+import SimpleContainerGenerator
+
+mkpath("my_image_name")
+cd("my_image_name")
+
+# Add private registries. General will always be included as a backup.
+# The first method uses your ssh credentials, whereas the second requires a
+# Personal Access Token.
+registry_urls = ["[email protected]:MyCompany/MyPrivateRegistry.git",
+                 "https://username:[email protected]/MyCompany/AnotherRegistry.git"]
+
+# Optionally, override the URL of your privately registered package. Useful if your registry
+# stores the URIs of your packages as git+ssh, but you wish to use PATs in your workflow.
+pkgs = [
+    (name = "Foo", url = "https://username:[email protected]/MyCompany/MyPackage.jl.git",),
+    (name = "Bar", ),
+    (name = "Baz", ),
+]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs;
+                                           julia_version = julia_version,
+                                           output_directory = pwd(),
+                                           registry_urls = registry_urls,
+                                           mount_ssh = true) # Only required if using the ssh method
+
+# Note: you may need to `ssh-add` your key before this command will work.
+run(`DOCKER_BUILDKIT=1 docker build --ssh default -t my_docker_username/my_image_name .`)
+```
+
 ## Docker cheatsheet
 
 | Command | Description |

src/config_to_template.jl

@@ -23,6 +23,8 @@ function Template(config::Config)
     apt_install = _generate_apt_install_command(config)
     julia_url, asc_url = _get_julia_url(config)
     parent_image = config.parent_image
+    registry_urls = config.registry_urls
+    mount_ssh_string = config.mount_ssh ? "--mount=type=ssh " : ""
     tests_must_pass_commands = _generate_tests_must_pass_commands(config)
 
     file_list_vector = File[
@@ -149,7 +151,10 @@ function Template(config::Config)
     push!(step_list_vector, RunStep("chmod 555 /usr/bin/julia"))
     push!(step_list_vector, RunStep("chmod 555 /usr/bin/no_sysimage_julia"))
     #
-    push!(step_list_vector, RunStep("cd /tmp; JULIA_DEBUG=all SIMPLECONTAINERGENERATOR_CONTAINER_NO_TEMP_DEPOT=\"true\" /usr/bin/no_sysimage_julia /opt/simplecontainergenerator_containers/install_packages.jl"))
+    if any(map(r->occursin("git@github", r), registry_urls))
+        push!(step_list_vector, RunStep("mkdir -p -m 600 ~/.ssh && ssh-keyscan github.com >> ~/.ssh/known_hosts"))
+    end
+    push!(step_list_vector, RunStep(mount_ssh_string * "cd /tmp; JULIA_DEBUG=all SIMPLECONTAINERGENERATOR_CONTAINER_NO_TEMP_DEPOT=\"true\" /usr/bin/no_sysimage_julia /opt/simplecontainergenerator_containers/install_packages.jl"))
     #
     push!(step_list_vector, RunStep("cd /tmp; JULIA_DEBUG=all /opt/bin/julia /opt/simplecontainergenerator_containers/backups_of_simplecontainergenerator_1.jl"))
     push!(step_list_vector, RunStep("cd /tmp; JULIA_DEBUG=all /opt/bin/julia /opt/simplecontainergenerator_containers/backups_of_simplecontainergenerator_2.jl"))

src/generate_install_packages.jl

@@ -17,6 +17,15 @@ function _to_packagespec_string(pkgs::AbstractVector{<:AbstractDict})
     return "Pkg.Types.PackageSpec[$(join(pkg_strings, ", "))]"
 end
 
+function _to_registries_string(registry_urls::Vector{String})
+    registries = String[]
+    for registry in registry_urls
+        push!(registries, "Pkg.Registry.add(Pkg.RegistrySpec(url = \"" * registry * "\"))")
+    end
+    isempty(registries) || push!(registries, "Pkg.Registry.add(Pkg.RegistrySpec(url = \"https://github.com/JuliaRegistries/General.git\"))")
+    return registries
+end
+
 function _generate_install_packages_content(config::Config)
     pkgs = config.pkgs
     no_test = config.no_test
@@ -30,8 +39,10 @@ function _generate_install_packages_content(config::Config)
         end
     end
     pkgs_string = _to_packagespec_string(pkgs)
+    registries = _to_registries_string(config.registry_urls)
     lines = String[
         "import Pkg",
+        registries...,
         "Pkg.add($(pkgs_string))",
         "for name in $(pkg_names_to_test) # pkg_names_to_test",
         "Pkg.add(name)",

src/types_config.jl

@@ -3,6 +3,8 @@ struct Config
     exclude_packages_from_sysimage::Vector{String}
     julia_cpu_target::String
     julia_version::Union{String, VersionNumber}
+    registry_urls::Vector{String}
+    mount_ssh::Bool
     make_sysimage::Bool
     no_test::Vector{String}
     packagecompiler_installation_command::String
@@ -28,6 +30,8 @@ function Config(pkgs::AbstractVector{<:AbstractDict{<:Symbol,<:AbstractString}}
                             _default_julia_cpu_target(),
                         julia_version::Union{AbstractString, VersionNumber} =
                             _default_julia_version(),
+                        registry_urls = String[],
+                        mount_ssh::Bool = false,
                         make_sysimage::Bool =
                             true,
                         no_test =
@@ -51,6 +55,8 @@ function Config(pkgs::AbstractVector{<:AbstractDict{<:Symbol,<:AbstractString}}
                     exclude_packages_from_sysimage,
                     julia_cpu_target,
                     julia_version,
+                    registry_urls,
+                    mount_ssh,
                     make_sysimage,
                     no_test,
                     packagecompiler_installation_command,