.gitlab-ci.yml キーワードリファレンス：Keywords

16.0の和訳。
そのまま訳すと変な感じがするけど、基本的そのまま訳している。

本家はこちら

このドキュメントはGitLabの .gitlab-ci.yml の構造を記入しています。
・GitLabの簡単な紹介は、クイックスタートガイドに従います。
・例のコレクションは、GitLab CI/CD Examples を参照してください。
・企業で使用されている大規模な .gitlab-ci.yml ファイルを見るときは、gitlabの.gitlab-ci.yml ファイルを参照してください。

.gitlab-ci.yml ファイルを編集しているとき、CI Lintツールで見ることができます。

もし、このページのコンテンツを編集しているなら、キーワードを文書化する指示に従ってください。

キーワード
GitLab CI/CDのパイプライン構成は以下の通りです。

パイプラインの動きを設定するグローバルキーワード
キーワード　　　　　説明
default　　　　　　　ジョブキーワードのカスタムデフォルト値
include　　　　　　　他のYAMLファイルから設定を取込む
stages　　　　　　　パイプラインステージの名称と順番
variables　　　　　　パイプライン内の全てのジョブに対して定義するCI/CDの変数
workflow　　　　　　どのような種類のパイプラインを動かすのかを定義

ジョブキーワードで設定するジョブ
after_script　　　　　ジョブが実行された後、一連のコマンドをオーバライドする
allow_failure　　　　 ジョブの失敗を許可し、失敗したジョブは、パイプライン失敗の原因にならない
artifacts　　　　　　　成功時にジョブに添付するファイルやディレクトリのリスト　
before_script　　　　ジョブが実行される前、一連のコマンドをオーバライドする
cache　　　　　　　　次回以降の実施時にキャッシュされるべきファイルのリスト
coverage　　　　　　指定されたジョブのコードカバレッジの設定
dast_configuration　ジョブレベルで、DASTプロファイルから設定を使用
dependencies　　　　アーティファクトを取得するジョブのリストを提供することにより、特定のジョブに渡すアーティファクトを制限する
environment　　　　　ジョブがデプロイされる環境の名前
except　　　　　　　　ジョブを作成しない条件
extends　　　　　　　ジョブが継承するコンフィギュレーションエントリ
image　　　　　　　　Docker imagesを使用
inherit　　　　　　　　全てのジョブが継承するグローバル設定の選択
interruptible　　　　　より新しい実行により冗長化されたときに、ジョブをキャンセルできるかどうか定義
needs　　　　　　　　ステージオーダーより早くジョブを実行する
only　　　　　　　　　ジョブが作成される時の条件
pages　　　　　　　　ジョブの実行結果を利用するためにGitLabのページにアップロードする
parallel　　　　　　　ジョブインスタンスを並行稼働する数
release　　　　　　　runner にオブジェクトの生成を指示する
resource_group　　　ジョブの同時実行数
retry　　　　　　　　失敗した場合に、いつ、何回ジョブを自動リトライするかを定義
rules　　　　　　　　選択されたジョブを作成するかどうかを決める条件リスト　→ rules に記載したジョブの属性や条件を判断してジョブを作成するかどうかを決める
script　　　　　　　runner により実行されるシェルスクリプト
secrets　　　　　　 CI/CD が必要とするジョブのsecrets
services　　　　　　Docker services イメージを使用
stage　　　　　　　 ジョブステージ定義
tags　　　　　　　　ランナーを選択するのに使用されるタグリスト
timeout　　　　　　　カスタムジョブレベルでのタイムアウトの定義。プロジェクト全体の定義よりも優先される
trigger　　　　　　　下流のパイプライントリガーを定義
variables　　　　　　ジョブレベルでのジョブ変数定義
when　　　　　　　　ジョブを動かすときを設定