手把手教学编写gitlab-ci.yml文件以及应用（最简单易懂实践）

最新推荐文章于 2024-04-27 17:44:26 发布
最新推荐文章于 2024-04-27 17:44:26 发布
阅读量1.2w 收藏 40
点赞数 10
分类专栏： gitlab devops 文章标签： ci devops
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_27759825/article/details/124691745
版权

编写gitlab-ci.yml文件以及应用

1. 在项目中创建gitlab-ci文件

在这里插入图片描述
把下面的内容复制进gitlab-ci文件

#流水线的stages的顺序可以自己定义
#相同阶段的任务将会并发的执行，上一个阶段的任务完整的结束之后，下一个阶段的任务才会开始执行 
stages:
  - check_code 
  - build
  - deploy 
job1:
  stage: check_code
  script:
     - echo 'stage1 job ，读取变量为:' $param1
 
 
job2:
  stage: build
  script:
     - echo 'stage2 job  ，读取变量为:' $param2
 
job3:
  stage: deploy
  script:
     - echo 'stage3 job  ，读取变量为:' $param3

2. 配置gitlab-ci文件中的变量

$param1,$param2,$param3这3个就是变量
进入Settings->CI/CD->Variables
在这里插入图片描述
设置参数值
param1=变量1
param2=变量2
param3=变量3
这些值我们在等下运行pipeline时看看是否在gitlab-ci被引用到

3. 配置gitlab runner

如果没有安装gitlab runner先去安装，怎么安装gitlab runner可以参考官网https://docs.gitlab.com/runner/install/
安装完后将runner注册进gitlab，gitlab上都写着指令教程，放心实践
我这个项目已经有了个组共享的runner，我就直接用就好了，可以在gitlab-ci文件上指定runner ，用tags属性
在这里插入图片描述

4. 运行pipeline

进入CI/CD->Pipelines->Run pipeline
在这里插入图片描述

在这里插入图片描述
运行后看到3个job，这就是stage定义的对应的job

在这里插入图片描述
点击job1，可以看到输出的日志，我打印出的信息，看到输出了param1定义的值“变量1”
在这里插入图片描述

依次点job2，job3也可以看到输出日志

在job1看到他分几个步骤

1. Preparing the "docker" executor（准备docker执行器，即容器运行环境这里默认加载的镜像是maven:3.5.2-jdk-7）
2. Preparing environment（准备环境）
3. Getting source from Git repository（拉取代码）
4. Executing "step_script" stage of the job script（执行脚本）

返回pipeline列表看看运行的pipeline
在这里插入图片描述
可以看到job1，job2，job3都是打钩的状态都是正常，点击可以查看该阶段的日志

5. gitlab-ci文件属性

属性含义
stages定义任务内的阶段，每个阶段必须从全局定义的阶段中选择
variables定义全局变量
stage选择全局定义的阶段，只能选其中一个
before_script在脚本执行前执行的指令
after_script在脚本执行后执行的指令
script由runner执行的shell脚本（必填项）
retry发生故障时自动重试作业的时间和次数（0，1,2）
image指定基础运行环境的docker镜像，如java，python，maven等
tags指定流水线使用哪个runner去运行，只能定义到一个具体的项目，tags的取值范围是该项目可见的runner
only限定某些分支或者某些tag
except排除某些分支和某些tag
services使用Docker services（服务）镜像
when什么时候运行作业
environment部署的环境名称
cache指定需要在job之间缓存的文件或目录
artifacts归档文件列表，指定成功后应附加到job的文件和目录的列表
dependencies当前作业依赖的其他作业，你可以使用依赖作业的归档文件
coverage作业的代码覆盖率
parallel指定并行运行的作业实例
trigger定义下游流水线的触发器
include作业加载其他YAML文件
pages上传GitLab Pages的结果
allow_failure允许作业失败，失败的作业不影响提交的状态

6. 属性额外说明

stages
定义流水线全局阶段，默认有3个阶段，build、test、deploy。如果作业未定义stage阶段，默认使用test阶段

when
用于实现在作业失败时或发生故障时运行的作业，可以设置下面几个值

on_success ：只有前面的阶段的所有作业都成功时才执行，这是默认值。
on_failure ：当前面阶段的作业至少有一个失败时才执行。
always : 无论前面的作业是否成功，一直执行本作业。
manual ：手动执行作业，作业不会自动执行，需要人工手动点击启动作业。
delayed : 延迟执行作业，配合 start_in 关键字一起作用， start_in 设置的值必须小于或等于1小时，start_in 设置的值示例： 10 seconds 、 30 minutes 、 1 hour ，前面的作业结束时计时器马上开始计时。

.符号
对于不想执行的job，可以在前面加“.”符号表示跳过

variables $引用变量
可以使用如${DATABASE_URL}来引用定义的变量

only 和 except

  1. only 和 except 中可以使用特殊的关键字，如 branches 、 tags 、 api 、 external 、 pipelines 、 pushes 、 schedules 、 triggers 、 web 、 merge_requests 、 chats 等
    在这里插入图片描述

  2. only 和 except 支持高级策略，refs 、 variables 、 changes 、 kubernetes 四个关键字可以使用。

7. 稍微复杂点的gitlab-ci文件

这个是在项目中的其中一个文件，仅供参考，没啥涉密的东西

variables:
  COVERAGE_WEBHOOK_URL: $COVERAGE_WEBHOOK_URI?branch=$CI_COMMIT_REF_NAME&gitlabPipelineId=$CI_PIPELINE_ID&gitlabProjectId=$CI_PROJECT_ID
  IMAGE_WEBHOOK_URL: $CI_SERVICE_URL/webhook/gitlabProjects/$CI_PROJECT_ID/pipelines/$CI_PIPELINE_ID/images
  imageTag: $CI_PROJECT_NAME-$DEPLOY_TIME_TAG-$CI_PIPELINE_ID
  DOCKER_TLS_CERTDIR: ''

stages:
  - code_check
  - push_images
  - deploy

code_check:
  stage: code_check
  image: 10.19.64.203:8080/ums/maven:3.6.0-jdk-8
  tags:
    - devops
  script:
    - mvn clean package -DskipTests
  artifacts:
    expire_in: 3 hrs
    paths:
      - ./ib-provider/target/*.jar


push_images:
  stage: push_images
  image: 10.19.64.203:8080/library/docker:19.03.14
  tags:
  - devops
  services:
  - 10.19.64.203:8080/library/docker:19.03.14-dind
  before_script:
  - mkdir -p $HOME/.docker
  - echo $DOCKER_AUTH_CONFIG > $HOME/.docker/config.json
  - docker info
  script:
  - docker build -t ${CI_REGISTRY_IMAGE_DIR}:${imageTag} . 
  - docker push ${CI_REGISTRY_IMAGE_DIR}:${imageTag}
  - wget --post-data "imageTag=$imageTag" $IMAGE_WEBHOOK_URL


deploy:
  stage: deploy
  image: harbor.uniin.cn/devops-ci/mvn:1.0.1
  tags:
    - devops
  script:
    - echo $imageTag
    - wget --no-check-certificate --header="Authorization:$AUTH_TOKEN" --post-data="pipelineId=$CI_PIPELINE_ID&ref=$CI_COMMIT_REF_NAME&imageName=$imageName&tag=$imageTag&deployVersion=$deployVersion&description=$description&deployParams=$deployParams&envName=$envName&deployType=$deployType" $DEPLOY_WEBHOOK_URL
  only:
    variables:
      - $IS_DEPLOY == "1"
  dependencies:
    - push_images
东坡不稗
关注
  • 10
    点赞
  • 踩
  • 40
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
前端项目gitlab CI/CD 流水线文件 .gitlab-ci.yml
08-17
使用gitlab ci/cd 部署前端项目，侵权必究 包含，docker镜像部署，远程服务器部署，阿里云OSS部署，华为云OBS部署。 如有疑问，可私信 拿我格子衫来 博主。
gitlab-ci-lint:gitlab-ci cli到lint .gitlab-ci.yml文件
04-29
gitlab-ci-lint gitlab-ci cli到lint .gitlab-ci.yml文件 用法 安装 npm install -g gitlab-ci-lint 命令行界面 Usage: gitlab-ci-lint [options] <file> Options: -h, --help output usage information -V, --version output the version number -u, --url [URL] Use alternative Gitlab URL -t, --token [TOKEN] Provide Gitlab personal access token, when it's needed 例子 .gitlab-ci.yml
gitlab-ci-yml：我的项目使用的GitLab CI配置文件的集合
02-08
gitlab-ci.yml 我的项目使用的GitLab CI配置文件的集合。 在完善和标准化docker项目的过程中，将其存储在此处。 入门 每个dockerfile都有一个简单的.gitlab-ci.yml文件，该文件使用我.gitlab-ci.yml映像之一。 该定义所引用的资源不包括在该项目中。 您可以从复制.gitlab-cy.yml ，然后替换相关位。 stages : - build build : stage : build image : jrbeverly/minify:baseimage script : - minify -o index-min.html index.html only : - master artifacts : paths : - public/ expire_in : 1
.gitlab-ci.yml文件参数配置和使用
mo_sss的博客
02-05 1757
每个人都有惰性，但不断学习是好好生活的根本，共勉！官网参考文档：https://docs.gitlab.com/ee/ci/index.html#the-gitlab-ciyml-file
gitlab-ci-local：厌倦了尝试测试您的.gitlab-ci.yml吗？
02-03
介绍 厌倦了测试您的.gitlab-ci.yml吗？ 以shell执行程序或docker执行程序的形式在本地运行gitlab管道。 摆脱所有那些特定于开发人员的Shell脚本并制作文件。 目录 例子 安装 NPM npm install -g gitlab-ci-local Linux 下载二进制文件并将其放在/usr/local/bin sudo su # must be installed as root, if placed in /usr/local/bin/ curl -L https://github.com/firecow/gitlab-ci-local/release
.gitlab-ci.yml 自定义多个stages. CI/CD 自定义多个阶段的执行顺序
知无涯
07-29 8360
使用全局变量stages定义多个stage. 会按照顺序执行. stages: - build - test - publish - deploy - deploy-notify build: stage: build script: - echo 'installing node_modul' only: - master test-cover: stage: test script: - echo 'test-cover' test.
.gitlab-ci.yml说明
mmgithub123的博客
05-07 7428
Gitlab官方文档：https://docs.gitlab.com/ee/ci/yaml/README.html https://docs.gitlab.com/ee/ci/yaml/gitlab_ci_yaml.html https://docs.gitlab.com/ee/ci/docker/using_docker_images.html GitLab CI/CD 是一个内置在GitL...
GitLab CI流水线配置文件.gitlab-ci.yml详解（三）
格物致知
07-31 1942
GitLab CI流水线配置文件.gitlab-ci.yml详解 … contents:: 目录 本文讲解在 :ref:GitLab的汉化与CI持续集成gitlab-runner的配置 <configure_gitlab_i18n_and_create_gitlab_ci_with_gitlab_runner> 的基础上，对GitLab CI流水线配置文件 .gitlab-ci.yml 进行详细的介绍。 文章目录GitLab CI流水线配置文件.gitlab-ci.yml详解1. 实验环境2.
gitlab-ci.yaml 配置文件详解
JineD的博客
09-22 1万+
通过 .gitlab-ci.yml配置任务 git仓库：https://github.com/Fennay/git... 此文档用于描述.gitlab-ci.yml语法，.gitlab-ci.yml文件被用来管理项目的runner 任务。 如果想要快速的了解GitLab CI ，可查看快速引导。 .gitlab-ci.yml 从7.12版本开始，GitLab CI使用YAML文件(.gitlab-ci.yml)来管理项目配置。该文件存放于项目仓库的根目录，它定义该项目如何构建。 开始构建之前YAM
.gitlab-ci.yml 配置文件详解
热门推荐
u014265398的博客
04-21 2万+
值 是否必须 描述 script 必须 定义由Runner执行的shell脚本或命令 extends 非必须 定义此作业将继承的配置条目 image 非必须 需要使用的docker镜像，请查阅该文档 services 非必须 定义所需的docker服务，请查阅该文档 stage 非必须 定义一个工作场景阶段，默认是test type 非必须 stage的别名,不赞成使用 variabl...
node-gitlab-ci:从TypeScript .ts文件动态创建.gitlab-ci.yml！
05-07
节点gitlab-ci 为每个项目使用JavaScript或TypeScript创建动态的GitLab CI管道。 重用和继承指令，避免重复代码！ 持续集成（CI）和持续部署（CD）是软件开发中流程自动化的绝佳概念。 我们喜欢GitLab CI，因为它在具有强大配置功能的集成解决方案中实现了这一概念。 但是，管道配置存储在静态.gitlab-ci.yml文件中。 node-gitlab-ci允许您在TypeScript中动态开发管道配置，并避免使用诸如继承或函数之类的编程概念在语句中重复。 这样，您就可以将Monorepos与许多类似的项目完美地集成到CI / CD中。 安装 导航到您的存储库，然后通过yarn或npm安装软件包： # Yarn yarn add -D node-gitlab-ci # NPM npm install --save-dev node-gitlab-c
.gitlab-ci.yml Model
04-24
GitLab Runner 自动部署发布项目的 .gitlab-ci.yml 文件模板
gitlab-ci-validate:检查您的 .gitlab-ci.yml 文件是否有效
05-31
gitlab-ci-validate 检查您的 .gitlab-ci.yml 文件是否有效。 感谢关于的帖子！安装： yarn global add gitlab-ci-validatenpm i -g gitlab-ci-validate用法： # It will try to find if .gitlab-ci.yml is present ...
jenkins-持续集成-创建job
雨水的早晨的博客
09-28 582
jenkins如何创建job
mac 安装jenkins，实现性能测试的持续集成
雨水的早晨的博客
09-27 654
找错误，安装jenkins的日志中有报错。BUT，启动了jenkins，但是访问。无能为力时，查看了brew的版本。安装jenkins时报各种错。继续脚本安装jenkins。
【DevOps入门到精通】导读：探索软件开发与运维的协同之道
Coder加油站的专栏
04-27 380
DevOps是一种文化和专业实践，旨在促进开发(Dev)和运维(Ops)团队的协作，通过自动化和监控整个软件构建、测试、发布到部署过程中的各个阶段。这种方法不仅提高了软件开发和发布的速度，还显著提升了工作效率和产品质量。定义与重要性：DevOps是一种文化和专业实践，旨在促进开发(Dev)与运营(Ops)的协作互动，通过自动化软件交付过程，改善和加速开发与部署的过程。基本原则：版本控制、持续集成(CI)、自动化测试、持续交付(CD)、快速反馈。
node-v9.6.0-x86.msi
最新发布
04-29
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
Python基于机器学习的分布式系统故障诊断系统源代码，分布式系统的故障数据进行分析，设计故障诊断模型，高效地分析并识别故障类别
04-29
基于技术手段（包括但不限于机器学习、深度学习等技术）对分布式系统的故障数据进行分析，设计故障诊断模型，高效地分析并识别故障类别，实现分布式系统故障运维的智能化，快速恢复故障的同时大大降低分布式系统运维工作的难度，减少运维对人力资源的消耗。在分布式系统中某个节点发生故障时，故障会沿着分布式系统的拓扑结构进行传播，造成自身节点及其邻接节点相关的KPI指标和发生大量日志异常
gitlab ci产物如何编写gitlab-ci.yml
05-25
编写 GitLab CI/CD 配置文件 `.gitlab-ci.yml` 的基本步骤如下： 1. 打开你的项目仓库，进入 `Settings` -> `CI/CD` -> `General pipelines settings`，启用 CI/CD 功能。 2. 在项目仓库中创建 `.gitlab-ci.yml` 文件，并在其中定义各个阶段的作业和所需的步骤。 3. 在 `.gitlab-ci.yml` 文件中，你需要定义以下内容： - `stages`：定义各个阶段的名称和执行顺序。 - `variables`：定义环境变量。 - `before_script`：定义所有作业都需要执行的命令。 - `after_script`：定义作业执行完毕后需要执行的命令。 - `jobs`：定义各个作业的名称、阶段、执行脚本等信息。 4. 编写完 `.gitlab-ci.yml` 文件之后，提交到项目仓库中，GitLab 会自动检测并执行配置文件中定义的作业。 下面是一个简单的 `.gitlab-ci.yml` 文件示例： ```yml stages: - build - test - deploy variables: JAVA_HOME: /usr/lib/jvm/java-11-openjdk-amd64 before_script: - echo "Setting up environment" - apt-get update -qy && apt-get install -y maven after_script: - echo "Tearing down environment" - rm -rf target/ build: stage: build script: - mvn package test: stage: test script: - mvn test deploy: stage: deploy script: - echo "Deploying to production server" ``` 在这个示例中，我们定义了三个阶段：`build`、`test` 和 `deploy`，每个阶段都有对应的作业。`before_script` 和 `after_script` 分别定义了作业执行前和执行后需要执行的命令。`variables` 中定义了一个环境变量 `JAVA_HOME`。 `build` 作业会执行 `mvn package` 命令，打包应用程序；`test` 作业会执行 `mvn test` 命令，运行测试用例；`deploy` 作业会执行 `echo "Deploying to production server"` 命令，将应用程序部署到生产环境中。 在实际使用中，你需要根据项目的具体情况修改 `.gitlab-ci.yml` 文件，以满足不同的需求。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值