读完本节内容,你可以学到:
YAML
语言的基本语法;.gitlab-ci.yml
配置文件详解;Gitlab-CI
的配置操作。
YAML
YAML
语言(发音 /ˈjæməl/
)的设计目的,就是为了方便人类读写配置文件。它本质上一种通用的数据串行化格式。
它的基本语法规则如下:
- 大小写敏感
- 使用缩进表示层级关系
- 缩进时不允许使用
Tab
键,只允许使用空格 - 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
#
表示注释,从这个字符一直到行尾,都会被解析器忽略。
YAML
支持的数据结构有三种:
- 对象:键值对的集合,又被称为映射(
mapping
) / 哈希(hashes
) / 字典(dictionary
) - 数组:一组按次序排列的值,又被称为序列(
sequence
) / 列表(list
) - 纯量(
scalars
):单个的、不可再分的值
YAML
还有一个小怪癖,所有的YAML
文件开始航都应该是---
开头,它是属于YAML
格式的一部分。
对象
对象是一组键值对,使用冒号结构表示:
---
animal: pets
复制代码
转为 JavaScript
如下:
{ animal: 'pets' }
复制代码
YAML
也允许另一种写法,将所有键值对携程一个行内对象:
---
hash: { name: Steve, foo: bar }
复制代码
转成 JavaScript
如下:
{ hash: { name: 'Steve', foo: 'bar' } }
复制代码
数组
一组连词线开头的行,构成一个数组:
---
- Cat
- Dog
- Goldfish
复制代码
转为 JavaScript
如下:
[ 'Cat', 'Dog', 'Goldfish' ]
复制代码
数据结构的子成员是一个数组,则可以在该项下面缩进空格:
---
-
- Cat
- Dog
- Goldfish
复制代码
转为 JavaScript
如下:
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
复制代码
YAML
的数组也可以采用行内表示法:
---
animal: [ Cat, Dog ]
复制代码
转为 JavaScript
如下:
{ animal: [ 'Cat', 'Dog' ] }
复制代码
复合结构
对象和数组可以结合使用,形成复合结构:
---
languages:
- Ruby
- Perl
- Python
websites:
`YAML`: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
复制代码
转为 JavaScript
如下:
{
languages: ['Ruby', 'Perl', 'Python'],
wesites: {
`YAML`: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.org',
},
}
复制代码
纯量
纯量是最基本的、不可再分的值。以下数据类型都属于 JavaScript
的纯量:
- 字符串
- 布尔值
- 整数
- 浮点数
Null
- 时间
- 日期
数值直接以字面量的形式表示:
number: 12.35
复制代码
转为 JavaScript
如下:
{ number: 12.30 }
复制代码
布尔值用 true
和 false
表示:
isSet: true
复制代码
转为 JavaScript
如下:
{ isSet: true }
复制代码
null
用 ~
表示:
parent: ~
复制代码
转为 JavaScript
如下:
{ parent: null }
复制代码
时间采用 ISO8601 格式:
iso8601: 2001-12-14t21:59:43.10-05:00
复制代码
转为 JavaScript
如下:
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }
复制代码
日期采用复合 iso8601 格式的年、月、日表示:
date: 1976-07-31
复制代码
转为 JavaScript
如下:
{ date: new Date('1976-07-31') }
复制代码
YAML
允许使用两个感叹号,强制转换数据类型:
port: !!str 8000
year: !!int '1991'
success: !!bool 'true'
distance: !!float '18.32'
复制代码
转为 JavaScript
如下:
{
port: '8000',
year: 1991,
success: true,
distance: 18.32,
}
复制代码
字符串
字符串是最常见的,也是最复杂的一种数据类型。
字符串默认不使用引号表示:
str: 这是一行字符串
复制代码
转为 JavaScript
如下:
{ str: '这是一行字符串' }
复制代码
如果字符串之中包含空格或者特殊字符,需要放在引号之中:
str: '内容 字符串'
复制代码
转为 JavaScript
如下:
{ str: '内容 字符串' }
复制代码
单引号和双引号都可以使用,双引号不会对特殊字符转义:
str1: '内容\n字符串'
str2: "内容\n字符串"
复制代码
转为 JavaScript
如下:
````JavaScript` { str1: '内容\n字符串', str2: '内容\n字符串' }
单引号之中如果还有单引号,必须连续使用两个引号转义:
```yaml
str: 'labor''s day'
复制代码
转为 JavaScript
如下:
{ str: 'labor\'s day' }
复制代码
字符串可以写成多行,从第二行开始,必须有一个单空格缩进,换行符会被转换为空格:
str: 这是一段
多行
字符串
复制代码
转为 JavaScript
如下:
{ str: '这是一段 多行 字符串' }
复制代码
多行字符串可以使用 |
保留换行符,也可以使用 >
折叠换行:
this: |
Foo
Bar
that: >
Foo
Bar
复制代码
转为 JavaScript
如下:
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
复制代码
+
表示保留文字块末尾的换行,-
表示删除字符串末尾的换行:
s1: |
Foo
s2: |+
Foo
s3: |-
Foo
复制代码
转为 JavaScript
如下:
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }
复制代码
字符串之中可以插入 HTML 标记:
message: |
<p style="color: red">
段落
</p>
复制代码
转为 JavaScript
如下:
{ message: '\n<p style="color: red">\n 段落\n</p>\n' }
复制代码
引用
锚点 &
和别名 *
,可以用来表示引用:
defaults: &defalts
adapter: postgres
host: localhost
development:
database: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults
复制代码
等同于下面的代码:
defaults:
adapter: postgres
host: localhost
development:
database: myapp_development
adapter: postgres
host: localhost
test:
database: myapp_test
adapter: postgres
host: localhost
复制代码
&
用来建立锚点(defaults
),<<
表示合并到当前数据,*
用来引用锚点:
- &showell Steve
- Clark
- Brian
- Oren
- *showell
复制代码
转为 JavaScript
如下:
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
复制代码
.gitlab-ci.yml
GitLab提供持续集成服务。如果将 .gitlab-ci.yml
文件添加到项目的根目录下,并将GitLab仓库配置为使用Runner,则每次提交或者推送时,GitLab都会查找该 .gitlab-ci.yml
文件,并根据该文件的内容在Runner上启动操作。