GitLab CIの複数行YAML文字列（.gitlab-ci.yml）

Question 1

gitlab-ci.ymlコマンドに複数行の文字列を使用するファイルを書き込もうとしています。ただし、解析されていないようです。との両方を試しましたが- |、- >同じ結果になりました。

stages:
  - mystage

Build:
  stage: mystage
  script:
    - |
        echo -e "
            echo 'hi';
            echo 'bye';
        "

実行しようとすると、実行echo -e 'するスクリプトとしてのみ表示され、複数行の文字列全体は表示されません。これは私にとって問題を引き起こします。

このようなものを書くための正しい構文は何でしょうか？

Question 2

TL; DR; Gitlab-CIによってコマンドとして発行できる単一行の文字列としてロードされる複数行のYAMLスカラー（読みやすさのため）を使用する必要があります。これを行うには、複数行に分散されたYAMLのプレーン（引用符なし）スカラーを使用します。

script:
- echo -e 
   "echo 'hi';
    echo 'bye';"

このようなスカラーにはYAMLによって課せられるいくつかの制限があることに注意してください。確かに知っておく必要があるのは、後続の各行が少なくとも1つ多くインデントされていることecho -e（コレクションノードに対して2つの位置がインデントされているが、まったくインデントされていない）、すべての改行がスペースに置き換えられていることです。ロードされたとき（したがって、改行を配置する場所に少し注意する必要があります）。

あなたの投稿には複数の誤解があり、間違った質問をすることになります。

複数行のYAML文字列のようなものはありません。YAMLにはスカラーがあり、これらのスカラーの一部はプログラムによって文字列としてロードできますが、その他のスカラーは整数、浮動小数点数などとしてロードされます。

文字列がコマンドラインとして解釈される可能性があるため、文字列としてロードされているスカラーノードに明らかに関心があります。ただし、Gitlab CIでは複数行のスクリプトがサポートされていないため（@Jordanが示すように）、複数行のコマンドライン（つまり、改行が埋め込まれている）は必要ありません。

読みやすくするために、YAMLの標準機能を使用して、複数行のスカラーを1行の文字列としてロードします。

読みやすさを気にしない場合は、次を使用できます。

- echo -e "\n    echo 'hi';\n    echo 'bye';\n"

また、スカラーは引用符で囲まれechoていないため（つまり、で始まる）、バックスラッシュや引用符に対してYAMLで特別なことを行う必要はありません。

スクリプトの結果は同じです（空の行を印刷echo 'hi';し、4スペースインデントされた行に印刷echo 'bye';し、4スペースインデントされた行に印刷します）。

読みやすくするために複数行の入力を使用する場合は、1行として読み込まれ、基本的に2つのオプションがあります。複数行の平面スカラーを使用するか、YAMLで折り返しスカラーを使用します。

複数行のプレーンスカラー

プレーンは、スカラーが引用符で囲まれていないことを意味し、YAMLの複数行のものと同様に、複数行は、次の行を適切にインデントする必要があることを意味します。この場合は、最初の行よりも遠くにあります。

script:
- echo -e 
   "echo 'hi';
    echo 'bye';"

改行はスペースに置き換えられるため、次のことは行わないでください。

script:
- echo -e 
   "echo 'hi';
    echo '
   bye';"

の前に表示されるスペースが表示されるためですbye。

このようなスカラー内でコロンの後にスペースを含めることはできないなど、いくつかの制限があります（これにより、キーと値のペアのように見えます）。

そこには、プレーンスカラで任意の文字をエスケープすることができないよう、無地のスカラーにバックスラッシュをエスケープする必要はありませんが、もちろん、あなたはバックスラッシュを含めることができ、YAMLからロードされた文字列になってしまいますし、そのことができ、実行コマンドの意味を持っていますその文字列から。

折りたたまれたスカラー

折りたたまれたスカラーは、すべての（単一の）改行がロード中にスペースに置き換えられるという点でプレーンスカラーに似ています。

script:
- >
  echo -e 
  "echo 'hi';
  echo 'bye';"

実際のコマンド情報は、少なくとも折りたたまれたスカラーインジケーター（>）と同じだけインデントする必要があります。

単純なスカラーとは異なり、のような:ものには特別な意味はありません。したがって、プレーンスカラーがYAMLエラーをスローして失敗した場合、同様の折りたたまれたスカラーは失敗しない可能性があります。

Question 3

これが問題になることを先取りしてここに来ましたが、読みやすさのために次の「複数行」コマンドが機能しています。

Gitlabランナー：ShellRunnerバージョン1.11.0 / Gitlabバージョン： 8.17.2

myjob:
stage: deploy
script:
  # Single line command
  - az component update --add sql

  # Multi-line command
  - az sql server create -n ${variable} -g ${variable} -l ${variable}
    --administrator-login ${variable} --administrator-login-password ${variable}

Question 4

yamlliteral_blockおよびanchors機能を介して任意の複数行のスクリプト/コマンドを使用できます。例：

.build: &build |
    echo -e "\n$hl🛠 Building $green$build_path/$build_assets_dir/*.js $nl\n"
    echo -e "javascript-obfuscator $build_path/$build_assets_dir/*.js"
[...]

build:master: 
  stage: build
  script:
    - *rsync
    - *build
[...]

Question 5

wp configcreateコマンドはかなり厄介でした.... gitlab-ciから...

build:
  stage: build
  script:
    - echo "Building the app"
    - |
        wp config create --dbname=$vardb --dbhost=$varhost --dbuser=$varusr --dbpass=$varpas --extra-php <<PHP
            define( 'WP_DEBUG', false );
            define( 'FS_METHOD', 'direct' );
            define( 'WP_POST_REVISIONS', 5 );
            define( 'AUTOSAVE_INTERVAL', 600 );
        PHP
    - scp ./wp-config.php continued...
  allow_failure: true

Question 6

これはTravisCIで私のために働いています

before_install:
  - set -e
  - |
    echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
    <settings xmlns=\"http://maven.apache.org/SETTINGS/1.0.0\"
              xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
              xsi:schemaLocation=\"http://maven.apache.org/SETTINGS/1.0.0
                                   http://maven.apache.org/xsd/settings-1.0.0.xsd\">
      <servers>
        <server>
          <id>github</id>
          <username>${GITHUB_USERNAME}</username>
          <password>${GITHUB_PASSWORD}</password>
        </server>
      </servers>
    </settings>
    " >  ${HOME}/.m2/settings.xml

ここでは、2つの環境変数（${GITHUB_USERNAME}および${GITHUB_PASSWORD}）も補間されます

Question 7

この形式は機能します。YAMLではプレーン（引用符なし）スカラーを使用します。たとえば、テラフォームバックエンドの初期化に使用されるスクリプト

  before_script:
    - cd ${TF_ROOT}
    - terraform init -backend-config="address=${GITLAB_TF_ADDRESS}"
      -backend-config="lock_address=${GITLAB_TF_ADDRESS}/lock"
      -backend-config="unlock_address=${GITLAB_TF_ADDRESS}/lock"
      -backend-config="username=${GITLAB_USER_LOGIN}" -backend-config="password=${GITLAB_ACCESS_TOKEN}"
      -backend-config="lock_method=POST" -backend-config="unlock_method=DELETE"
      -backend-config="retry_wait_min=5"