Commit d73afa3
authored
doc(README): Make shell snippet copy&paste safe (#336)
Many bash/shell snippets in the README use an environment variable
`YOUR_CONTAINER_REGISTRY`, which is used as `$YOUR_CONTAINER_REGISTRY`.
However, that has the downside that if users copy & paste the snippet
and accidentally press enter or use a shell that doesn't allow multi-
line pasting (and executes it immediately), then the variable will be
replaced by an empty string, because it wasn't set before.
It's good practice to make those snippets copy&paste-safe. We can
achieve that by adding `:?` to the variable, which emits an error if the
variable is unset or null.
See https://devhints.io/bash for a bash cheat sheet.
Example:
```sh
docker push ${YOUR_CONTAINER_REGISTRY:?}/bookshop-srv
```
On ZSH:
```
zsh: YOUR_CONTAINER_REGISTRY: parameter not set
```
On Bash:
```
bash: YOUR_CONTAINER_REGISTRY: parameter null or not set
```1 parent 681eb89 commit d73afa3
1 file changed
+10
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
169 | 169 | | |
170 | 170 | | |
171 | 171 | | |
172 | | - | |
| 172 | + | |
173 | 173 | | |
174 | 174 | | |
175 | 175 | | |
| |||
447 | 447 | | |
448 | 448 | | |
449 | 449 | | |
450 | | - | |
| 450 | + | |
451 | 451 | | |
452 | 452 | | |
453 | 453 | | |
| |||
456 | 456 | | |
457 | 457 | | |
458 | 458 | | |
459 | | - | |
| 459 | + | |
460 | 460 | | |
461 | 461 | | |
462 | 462 | | |
463 | 463 | | |
464 | | - | |
| 464 | + | |
465 | 465 | | |
466 | 466 | | |
467 | 467 | | |
| |||
471 | 471 | | |
472 | 472 | | |
473 | 473 | | |
474 | | - | |
| 474 | + | |
475 | 475 | | |
476 | 476 | | |
477 | 477 | | |
| |||
481 | 481 | | |
482 | 482 | | |
483 | 483 | | |
484 | | - | |
| 484 | + | |
485 | 485 | | |
486 | 486 | | |
487 | 487 | | |
| |||
493 | 493 | | |
494 | 494 | | |
495 | 495 | | |
496 | | - | |
| 496 | + | |
497 | 497 | | |
498 | | - | |
| 498 | + | |
499 | 499 | | |
500 | 500 | | |
501 | 501 | | |
502 | 502 | | |
503 | 503 | | |
504 | | - | |
| 504 | + | |
505 | 505 | | |
506 | 506 | | |
507 | 507 | | |
508 | 508 | | |
509 | 509 | | |
510 | | - | |
| 510 | + | |
511 | 511 | | |
512 | 512 | | |
513 | 513 | | |
| |||
0 commit comments