Merge pull request #80 from bcbi/dpa/parent-image

Document the `parent_image` keyword argument

Author: DilumAluthge

.github/workflows/predictmd.yml

@@ -28,7 +28,7 @@ jobs:
           arch: ${{ matrix.arch }}
       - uses: julia-actions/julia-buildpkg@latest
       - uses: julia-actions/julia-runtest@latest
-      - run: julia --project -e 'import SimpleContainerGenerator; pkgs = [(name = "PredictMD", rev = "master", ), (name = "PredictMDExtra", rev = "master", ), (name = "PredictMDFull", rev = "master", ), (name = "UnicodePlots", version = "1.2.0 - *", ),]; no_test = String["UnicodePlots"];  SimpleContainerGenerator.create_dockerfile(pkgs; no_test = no_test)'
+      - run: julia --project -e 'import SimpleContainerGenerator; pkgs = [(name = "PredictMD", rev = "master", ), (name = "PredictMDExtra", rev = "master", ), (name = "PredictMDFull", rev = "master", ), (name = "UnicodePlots", version = "1.2.0 - *", ),]; no_test = String["UnicodePlots"]; parent_image = "nvidia/cuda"; SimpleContainerGenerator.create_dockerfile(pkgs; no_test = no_test, parent_image = parent_image)'
       - if: github.ref == 'refs/heads/master' && (github.event_name == 'push' || github.event_name == 'schedule')
         env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}

Project.toml

@@ -1,7 +1,7 @@
 name = "SimpleContainerGenerator"
 uuid = "b8d349fb-717b-4aac-a9b1-e1da4219c631"
 authors = ["Dilum Aluthge"]
-version = "1.1.1"
+version = "1.2.0"
 
 [deps]
 PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"

README.md

@@ -33,8 +33,12 @@ pkgs = [
     "Bar",
     "Baz",
 ]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version)
 
-SimpleContainerGenerator.create_dockerfile(pkgs, pwd(); julia_version = v"1.4.0")
 run(`docker build -t my_docker_username/my_image_name .`)
 ```
 
@@ -51,8 +55,12 @@ pkgs = [
     (name = "Bar",),
     (name = "Baz",),
 ]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version)
 
-SimpleContainerGenerator.create_dockerfile(pkgs, pwd(); julia_version = v"1.4.0")
 run(`docker build -t my_docker_username/my_image_name .`)
 ```
 
@@ -69,8 +77,12 @@ pkgs = [
     (name = "Bar", version = "4.5.6",), # and replace the version numbers with actual version numbers for the packages
     (name = "Baz", version = "7.8.9",),
 ]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version)
 
-SimpleContainerGenerator.create_dockerfile(pkgs, pwd(); julia_version = v"1.4.0")
 run(`docker build -t my_docker_username/my_image_name .`)
 ```
 
@@ -87,8 +99,90 @@ pkgs = [
     (name = "Bar", version = "4.5.6",), # and replace the version numbers with actual version numbers for the packages
     (name = "Baz", rev     = "master",), # and replace "master" with the name of the branch you want to use
 ]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version)
+
+run(`docker build -t my_docker_username/my_image_name .`)
+```
+
+### Example 5
+
+```julia
+import SimpleContainerGenerator
+
+mkpath("my_image_name")
+cd("my_image_name")
+
+pkgs = [
+    "Foo", # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
+    "Bar",
+    "Baz",
+]
+no_test = [
+    "Foo", # Replace Foo, etc. with the names of actual packages
+    ]
+exclude_packages_from_sysimage = [
+    "Bar", # Replace Bar, etc. with the names of actual packages
+    ]
+julia_version = v"1.4.0"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version,
+                                           no_test = no_test,
+                                           exclude_packages_from_sysimage = exclude_packages_from_sysimage)
+
+run(`docker build -t my_docker_username/my_image_name .`)
+```
+
+### Example 6
+
+```julia
+import SimpleContainerGenerator
+
+mkpath("my_image_name")
+cd("my_image_name")
+
+pkgs = [
+    "Foo", # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
+    "Bar",
+    "Baz",
+]
+julia_version = v"1.4.0"
+parent_image = "ubuntu:latest"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version,
+                                           parent_image = parent_image)
+
+run(`docker build -t my_docker_username/my_image_name .`)
+```
+
+### Example 7
+
+```julia
+import SimpleContainerGenerator
+
+mkpath("my_image_name")
+cd("my_image_name")
+
+pkgs = [
+    "Foo", # Replace Foo, Bar, Baz, etc. with the names of actual packages that you want to use
+    "Bar",
+    "Baz",
+]
+julia_version = v"1.4.0"
+parent_image = "nvidia/cuda:latest"
+
+SimpleContainerGenerator.create_dockerfile(pkgs,
+                                           pwd();
+                                           julia_version = julia_version,
+                                           parent_image = parent_image)
 
-SimpleContainerGenerator.create_dockerfile(pkgs, pwd(); julia_version = v"1.4.0")
 run(`docker build -t my_docker_username/my_image_name .`)
 ```
 

src/public_create_dockerfile.jl

@@ -8,6 +8,7 @@ const _create_dockerfile_kwargs_docstring = """
 - `julia_version::Union{String, VersionNumber}`
 - `make_sysimage::Bool`
 - `no_test::Vector{String}`
+- `parent_image::String`
 
 ### Advanced Keyword Arguments
 - `override_default_apt::Vector{String}`