Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统

前言

Gitea 是一个用于代码托管的轻量级单体程序,它能与现有的经典应用集成,诸如代码分析工具 SonarQube、持续集成工具 Drone、Jenkins 以及用于工单管理的客户端插件(VSCode、Jenkins IDE)。 不久之后,Gitea 也将迎来自身集成的一体化 CI/CD 功能。

今天要介绍的是 Gitea 与 Jenkins CI/CD 的集成。

关于 Jenkins

Jenkins 是一款开源的、提供友好操作界面的持续集成(CI)工具,在国内外都有众多的使用者。Jenkins 具有以下优点:

  • 界面友好
  • 插件丰富
  • 可编程的 API
  • 历史悠久、社区活跃

因此 Jenkins 也被众多的企业或者组织用来构建自己的 CI/CD 系统。

然而,Jenkins 本身并不具备源代码管理的能力,对于一个完整的 CI/CD 系统来讲,必须要从源代码管理系统开始。所以,本文将介绍如何利用 Gitea 和 Jenkins 来构建一个完整的 CI/CD 系统。

关于 Jenkins 的 Gitea 插件

Jenkins 支持从通用 Git 服务器拉取代码,无需安装额外的插件即可配合 Gitea 使用。用于 Jenkins 的 Gitea 插件作用在于将 Jenkins CI/CD 权限直接赋予 Gitea 服务器上被授权的组织或个人,用户无需单独为每一个仓库配置 Jenkins 触发器即可享受 CI/CD 功能。

当用户在仓库中创建 Jenkinsfile 时,Jenkins 能够自动扫描到该仓库并启动 CI/CD 流水线。

插件详情:https://plugins.jenkins.io/gitea/

流程概览

本次集成实践主要包含以下内容

  • Gitea Plugin 插件的介绍和配置
  • Gitea + Jenkins 的 CI/CD 环境搭建
  • 利用 Gitea 的 Webhook 功能,从 Gitea 侧触发 Jenkins Pipeline

Gitea

  1. 在 Gitea 注册用户 Jenkins,同时为用户 Jenkins 添加 API Access Token,用于 Jenkins 从 Gitea 拉取代码
  2. 在 Gitea 中创建组织 GiteaTeam,并且将 Jenkins 用户添加为组织管理员
  3. 在 GiteaTeam 组织中创建代码仓库 JenkinsExample
  4. 修改 Gitea 服务器的 Webhook 设置

Jenkins

  1. 登录 Jenkins 管理面板,安装插件:Gitea
  2. 打开 Manage Credentials 添加 Gitea 访问令牌,用于从 Gitea 拉取代码、通过 API 安装 Webhook
  3. 打开 Configure System 配置 Gitea Server 插件,填写 Gitea 服务器地址和 Mange Hooks 令牌(选用上一步填写的 Credentials)
  4. 集成演示 JenkinsExample

Gitea + Jenkins 的 Docker Compose 配置示例

如果您还没有搭建以上环境,我们提供了一个 docker-compose.yml 模板帮助您快速启动,模板内容附在本文最后。

Gitea 与 Jenkins 的集成实践

生成 Gitea 访问令牌

在本示例中,我们为 Jenkins 单独创建了一个名为 Jenkins 的 Gitea 用户账号,便于 Jenkins 使用令牌访问 Gitea 服务器。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图1

为 Jenkins 授予 Gitea 项目的访问权限

在本示例中,我们在 Gitea 服务器创建了一个组织 GiteaTeam 用于存放项目源代码。同时,将 Jenkins 账号加入 GiteaTeam 的管理员用户组,便于 Jenkins 直接访问当前项目的代码仓库、API、Webhook。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图2

修改 Gitea 服务器的 Webhook 设置

conf/app.ini 中添加 ALLOWED_HOST_LIST = * 允许从外部服务器触发 Gitea webhook。

[webhook]
ALLOWED_HOST_LIST = *

安装 Gitea Plugin

在 Jenkins 依次打开 系统管理 - 插件管理,在 可选插件 中搜索并安装 Gitea

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图3

在 Jenkins 中添加 Gitea 访问令牌

打开 Manage Credentials 添加 Gitea 访问令牌,用于从 Gitea 拉取代码、通过 API 安装 Webhook。

  • Kind: 选择 Gitea Personal Access Token
  • Scope: 选择 Global
  • Token: 填写从 Gitea 申请的访问令牌

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图4

在 Jenkins 中配置 Gitea Server

Gitea Plugin 安装完成后,在 Jenkins 依次打开 系统管理 - 系统配置,找到 Gitea Server 并填写:

  • Name: 任意填写一个名称
  • Server URL: 填写 Gitea 服务器的 HTTP 地址,如 https://gitea.com
  • 勾选 Manage hooks 并选择访问令牌。这将允许 Jenkins 使用您选择的 Gitea 帐户自动配置 Gitea Webhook,当代码提交到 Gitea 时,Gitea 通过 Webhook (http://JENINS_URL/gitea-webhook/post) 触发 Jenkins CI。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图5

在 Jenkins 中创建 Organization Folder

Organization Folder 任务支持从 Gitea 服务器扫描并自动添加组织或用户目录下的所有代码仓库。当代码仓库中包含 Jenkinsfile 时会自动将该仓库加入流水线队列。在这种模式下,该组织下的代码仓库无需单独配置 Webhook 便可以自动与 Jenkins CI 集成。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图6

配置 Repository Sources

打开刚才创建的 Organization Folder。在 Projects - Repository Sources 中添加 Gitea Organization 并填写:

  • Server: 选择一个 Gitea Server
  • Owner: 与 Jenkins 集成的 Gitea 组织或个人目录
  • Credentials: 选择一个用于访问 Gitea 的 Jenkins 账号访问令牌(应该拥有 Owner 的管理权限)

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图7

稍后,Jenkins 就会开始扫描 Gitea 服务器上的 GiteaTeam 组织,在 Scan Gitea Organization Log 呈现出扫描结果:

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图8

集成演示 JenkinsExample

在上面的集成配置中,我们为 Gitea 服务器上的 GiteaTeam 组织集成了 Jenkins CI 能力。于是,当用户在 GiteaTeam 组织中创建包含 Jenkinsfile 的代码仓库时, Jenkins CI 也将自动启动,为 Gitea 配置 Webhook。当用户再次提交代码到 Gitea 服务器时,Jenkins 就能被 Gitea Webhook 触发构建过程。

创建 JenkinsExample 项目

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图9

Jenkinsfile 示例

JenkinsExample 项目中仅包含一个有效的 Jenkinsfile 示例文件,用于演示 Jenkins CI 与 Gitea 的集成。

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'echo build'
            }
        }
        stage('Test'){
            steps {
                sh 'echo test'
            }
        }
        stage('Deploy') {
            steps {
                sh 'echo publish'
            }
        }
    }
}

检查 Gitea Plugin 创建的 Webhook

当我们的组织与 Jenkins 集成之后,Gitea Plugin 插件自动为新建的 Jenkins 项目创建 Webhook。(前提是在 Gitea Plugin 中勾选 Manage hook)

检查 Gitea Plugin 自动为 Gitea 创建的 Webhook:

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图10

提交代码更改并查看 Jenkins CI 流程

  1. 在 Gitea 的提交列表中,我们可以观察到当前代码提交的构建情况,黄色的 ● 表示正在进行构建任务,绿色的 ✔ 表示已经完成的构建任务。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图11

  1. 点击上面的 ●、✔、× 符号可以进入 Jenkins Pipeline 查看任务详情情况。

Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统插图12

Gitea + Jenkins 的 Docker Compose 配置示例

最新的 Docker Enginine 已经集成了 docker compose 命令,您可以使用 docker compose up -d 一键启动 Gitea 和 Jenkins。

version: "3"

volumes:
  jenkins_home:

services:
  server:
    image: gitea/gitea:latest
    container_name: gitea
    environment:
      - USER_UID=1000
      - USER_GID=1000
    restart: always
    volumes:
      - ./data:/data
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
    ports:
      - 3000:3000

  jenkins:
    container_name: jenkins
    image: jenkins/jenkins:lts-jdk11
    restart: on-failure
    privileged: true
    volumes:
      - jenkins_home:/var/jenkins_home
      - /var/run/docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime:ro
    ports:
      - 8080:8080
      - 50000:50000

文章来源于互联网:Gitea 与 Jenkins 的集成实践,打造你的专属 CI/CD 系统

THE END
分享
二维码