Skip to content

Commit e1fd4c1

Browse files
committed
Add missing reference docs for packaging.* directives
1 parent 7de2e66 commit e1fd4c1

File tree

3 files changed

+55
-2
lines changed

3 files changed

+55
-2
lines changed

modules/directives/src/main/scala/scala/build/preprocessing/directives/Packaging.scala

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,13 @@ import scala.cli.commands.SpecificationLevel
2121
@DirectiveExamples("//> using packaging.packageType assembly")
2222
@DirectiveExamples("//> using packaging.output foo")
2323
@DirectiveExamples("//> using packaging.provided org.apache.spark::spark-sql")
24-
@DirectiveExamples("//> using packaging.dockerFrom openjdk:11")
2524
@DirectiveExamples("//> using packaging.graalvmArgs --no-fallback")
25+
@DirectiveExamples("//> using packaging.dockerFrom openjdk:11")
26+
@DirectiveExamples("//> using packaging.dockerImageTag 1.0.0")
27+
@DirectiveExamples("//> using packaging.dockerImageRegistry virtuslab")
28+
@DirectiveExamples("//> using packaging.dockerImageRepository scala-cli")
29+
@DirectiveExamples("//> using packaging.dockerCmd sh")
30+
@DirectiveExamples("//> using packaging.dockerCmd node")
2631
@DirectiveUsage(
2732
"""using packaging.packageType [package type]
2833
|using packaging.output [destination path]
@@ -32,11 +37,26 @@ import scala.cli.commands.SpecificationLevel
3237
|using packaging.dockerImageTag [image tag]
3338
|using packaging.dockerImageRegistry [image registry]
3439
|using packaging.dockerImageRepository [image repository]
40+
|using packaging.dockerCmd [docker command]
3541
|""".stripMargin,
3642
"""`//> using packaging.packageType` _package-type_
3743
|
3844
|`//> using packaging.output` _destination-path_
3945
|
46+
|`//> using packaging.provided` _module_
47+
|
48+
|`//> using packaging.graalvmArgs` _args_
49+
|
50+
|`//> using packaging.dockerFrom` _base-docker-image_
51+
|
52+
|`//> using packaging.dockerImageTag` _image-tag_
53+
|
54+
|`//> using packaging.dockerImageRegistry` _image-registry_
55+
|
56+
|`//> using packaging.dockerImageRepository` _image-repository_
57+
|
58+
|`//> using packaging.dockerCmd` _docker-command_
59+
|
4060
|""".stripMargin
4161
)
4262
@DirectiveDescription("Set parameters for packaging")

website/docs/commands/package.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,3 +525,12 @@ The using directive allows you to define the image repository.
525525
```scala compile power
526526
//> using packaging.dockerImageRepository scala-cli
527527
```
528+
529+
#### packaging.dockerCmd
530+
531+
The using directive allows you to override the executable used to run the application in docker,
532+
otherwise it defaults to `sh` for the JVM platform and `node` for the JS platform
533+
534+
```scala compile power
535+
//> using packaging.dockerCmd node
536+
```

website/docs/reference/directives.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,20 @@ Set parameters for packaging
248248

249249
`//> using packaging.output` _destination-path_
250250

251+
`//> using packaging.provided` _module_
252+
253+
`//> using packaging.graalvmArgs` _args_
254+
255+
`//> using packaging.dockerFrom` _base-docker-image_
256+
257+
`//> using packaging.dockerImageTag` _image-tag_
258+
259+
`//> using packaging.dockerImageRegistry` _image-registry_
260+
261+
`//> using packaging.dockerImageRepository` _image-repository_
262+
263+
`//> using packaging.dockerCmd` _docker-command_
264+
251265

252266

253267
#### Examples
@@ -257,9 +271,19 @@ Set parameters for packaging
257271

258272
`//> using packaging.provided org.apache.spark::spark-sql`
259273

274+
`//> using packaging.graalvmArgs --no-fallback`
275+
260276
`//> using packaging.dockerFrom openjdk:11`
261277

262-
`//> using packaging.graalvmArgs --no-fallback`
278+
`//> using packaging.dockerImageTag 1.0.0`
279+
280+
`//> using packaging.dockerImageRegistry virtuslab`
281+
282+
`//> using packaging.dockerImageRepository scala-cli`
283+
284+
`//> using packaging.dockerCmd sh`
285+
286+
`//> using packaging.dockerCmd node`
263287

264288
### Platform
265289

0 commit comments

Comments
 (0)