How to call multiple multiline commands in a yml script? - bash

Question

I'm not quite sure how to add a multiline script with multiple commands in a yml file of my CI - which is in my case a .gitlab-ci.yml:
production:
stage: deploy
image: ${DOCKER_IMAGE}
script:
- while IFS='-' read -r dom app; do
docker stop "$dom-$app" || true &&
docker rm "$dom-$app" || true
docker run
--name "$dom-$app"
--detach
--restart=always
-e VIRTUAL_HOST=$dom
"$dom-$app":latest
done < $FILE
So what I'm doing here is to read a file with a list of apps. For each line I have to stop the existing docker image, remove it and run the new one with some parameters.
How do I have to connect the docker commands (stop, rm and run)? Maybe a &&?
Do I have to use " for $dom-$app?

Answer 1

There are several ways to create multiline strings in YAML.
The way you are using the multiline plain string, all lines will be folded together with spaces.
Also your last line of the string isn't indented enough.
Longer strings like that should be quoted, because chances are high that there is a : or # inside the string which is special in YAML.
I suggest using literal block style, because that means the text will be interpreted exactly as you see it:
script:
- |
while IFS='-' read -r dom app; do
docker stop "$dom-$app" || true
docker rm "$dom-$app" || true
docker run \
--name "$dom-$app" \
--detach \
--restart=always \
-e VIRTUAL_HOST=$dom \
"$dom-$app":latest
done < $FILE
(Note that sequences (items starting with -) don't have to be indented, that's why the - is directly below script.)
You can find more information about YAML quoting styles on my website:
https://www.yaml.info/learn/quote.html