publicWagsHome/buildx
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

monitor: on-error: add docs for long form

Browse Source 
Signed-off-by: Kohei Tokunaga <ktokunaga.mail@gmail.com>
This commit is contained in:
Kohei Tokunaga
2023-06-27 22:11:34 +09:00
parent ef29ef65a2
commit 0e4b938d0d
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/guides/debugging.md
View File

@@ -51,14 +51,19 @@ dev home media opt root sbin sys usr work
Optional long form allows you specifying detailed configurations of the process. Optional long form allows you specifying detailed configurations of the process.
It must be CSV-styled comma-separated key-value pairs. It must be CSV-styled comma-separated key-value pairs.
Supported keys are `args` (can be JSON array format), `entrypoint` (can be JSON array format), `env` (can be JSON array format), `user`, `cwd` and `tty` (bool). Supported keys for configuring containers are `args` (can be JSON array format), `entrypoint` (can be JSON array format), `env` (can be JSON array format), `user`, `cwd` and `tty` (bool).
You can also specify `type=on-error` if you want to change the configuration of the container (e.g. commands to execute) that will be executed from the failed step.
Example: Examples:
``` ```
$ docker buildx build --invoke 'entrypoint=["sh"],"args=[""-c"", ""env | grep -e FOO -e AAA""]","env=[""FOO=bar"", ""AAA=bbb""]"' . $ docker buildx build --invoke 'entrypoint=["sh"],"args=[""-c"", ""env | grep -e FOO -e AAA""]","env=[""FOO=bar"", ""AAA=bbb""]"' .
``` ```
```
$ docker buildx build --invoke 'type=on-error,args=bash' .
```
#### `on-error` #### `on-error`
If you want to start a debug session when a build fails, you can use If you want to start a debug session when a build fails, you can use
@@ -85,6 +90,12 @@ Interactive container was restarted with process "edmzor60nrag7rh1mbi4o9lm8". Pr
This allows you to explore the state of the image when the build failed. This allows you to explore the state of the image when the build failed.
You can also use long-form flag with `type=on-error` option.
```
$ docker buildx build --invoke 'type=on-error,args=bash' .
```
#### `debug-shell` #### `debug-shell`
If you want to drop into a debug session without first starting the build, you If you want to drop into a debug session without first starting the build, you