gitlab cicd(四) gitlab ci文件编写规范格式
2019-08-01 本文已影响3人
lyy910203
官方文档
https://docs.gitlab.com/ce/ci/yaml/README.html
通用示例
stages: #定义步骤列表类型，从上往下执行
- build
- release
build: #job名字
stage: build #和stages对应的名字
image: i.harbor.xxxx.com/public/node:10-alpine-node-sass #使用的镜像，如果不写，就是注册runner默认镜像
script: #镜像执行命令，这里我构建node的东西
- npm install && npm run build
- ls -al
artifacts: #构建完成后，构建的产物（目录或者文件），丢给后面的步骤
paths:
- .nuxt/
- .
tags: #选择runner的tag
- rancher
- dev
only: #构建选择，如下，只选择develop的分支构建
- develop
release:
stage: release
before_script: #执行前执行
- eval $(ssh-agent -s)
- echo "$HIFIVE_SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - > /dev/null
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
image: i.harbor.xxxx.net/public/ssh-client:rsync
script:
- ssh -p 22 -o StrictHostKeyChecking=no root@1.1.1.1 -- "pm2 del hifive-openmusic-web|true"
- rsync -azP --exclude=".gitignore" --exclude=".git" --delete ./ root@1.1.1.1:/data/wwwroot/hifive-openmusic-web/
- ssh -p 22 -o StrictHostKeyChecking=no root@1.1.1.1 -- "ls -al /data/wwwroot/hifive-openmusic-web/"
- ssh -p 22 -o StrictHostKeyChecking=no root@1.1.1.1 -- "cd /data/wwwroot/hifive-openmusic-web/ && pm2 start npm --watch --name hifive-openmusic-web -- run start "
tags:
- rancher
- dev
only:
- develop
when: on_success #只有当上一个job成功才执行，默认就是on_success
| name | 说明 |
|---|---|
| script | 由Runner执行的Shell脚本。 |
| image | 使用docker镜像。也可用：image:name和image:entrypoint。image: centos:7 |
| services | 使用docker services图像。也可用：services:name，services:alias，services:entrypoint，和services:command。 |
| before_script | 覆盖在作业之前执行的一组命令。 |
| after_script | 覆盖作业后执行的一组命令。 |
| stages | 定义管道中的阶段。列表 |
| stage | 定义作业阶段（默认值:) test。 |
| only | 创建作业时限制（常用于分支选择）。也可用：only:refs，only:kubernetes，only:variables，和only:changes。常见用法：only: - branches #所有分支 - tags - /^issue-.*$/ #正则匹配issue-的分支 - master #master分支 |
| except | 在未创建作业时限制（常用于排除分支）。也可用：except:refs，except:kubernetes，except:variables，和except:changes。 |
| tags | 用于选择Runner的标签列表常用范例：tags: - runner - dev |
| allow_failure | 让工作失败。失败的作业无助于提交状态。 |
| when | 什么时候开始工作。参数： on_success:只有当前一个阶段的所有工作都成功时（或者因为它们被标记而被认为是成功的allow_failure）才执行工作 。这是默认值。 on_failure:仅当前一阶段的至少一个作业失败时才执行作业。 always:无论先前阶段的工作状态如何，都可以执行工作。 manual:手动执行作业（在GitLab 8.10中添加）。 |
| environment | 作业部署到的环境的名称。也可用：environment:name，environment:url，environment:on_stop，和environment:action。 |
| cache | 后续运行之间应缓存的文件列表。也可用：cache:paths，cache:key，cache:untracked，和cache:policy。 |
| artifacts | （构建产物交给下一个阶段）成功附加到作业的文件和目录列表。也可用：artifacts:paths，artifacts:name，artifacts:untracked，artifacts:when，artifacts:expire_in，artifacts:reports，和artifacts:reports:junit。在GitLab 企业版，这些都是可供选择：artifacts:reports:codequality，artifacts:reports:sast，artifacts:reports:dependency_scanning，artifacts:reports:container_scanning，artifacts:reports:dast，artifacts:reports:license_management，artifacts:reports:performance和artifacts:reports:metrics。常用范例： artifacts: #构建完成后，构建的产物（目录或者文件），丢给后面的步骤 paths: - .nuxt/ - . |
| dependencies | 作业所依赖的其他作业，以便您可以在它们之间传递工件。 |
| coverage | 给定作业的代码覆盖率设置。 |
| retry | 在发生故障的情况下，可以自动重试作业的次数和次数。 |
| parallel | 应该并行运行多少个作业实例。 |
| trigger | 定义下游管道触发器。 |
| include | 允许此作业包含外部YAML文件。也可用：include:local，include:file，include:template，和include:remote。 |
| extends | 此作业将继承的配置条目。 |
| pages | 上传作业结果以用于GitLab Pages。 |
| variables | 在作业级别定义作业变量。 |
我的网站
爱运维：https://www.iyunw.cn
python粉丝:https://www.pythonfans.cn
