concourse/hg-resource

Mercurial Resource

概述

Mercurial Resource 是一个专为 Concourse CI 设计的资源类型，用于与 Mercurial (Hg) 版本控制系统集成。其核心功能是跟踪 Mercurial 仓库的提交历史，支持在 CI/CD 流水线中监控代码变更，实现自动化触发构建、测试等任务。该资源的源代码和详细文档托管于 https://github.com/concourse/hg-resource%E3%80%82

核心功能和特性

• 提交跟踪：定期检查 Mercurial 仓库，自动识别新提交并记录变更集信息（如哈希、作者、时间戳等）。
• 版本控制集成：与 Mercurial 仓库无缝对接，支持公开仓库和需认证的私有仓库访问。
• 路径过滤：可配置特定目录或文件路径，仅监控指定路径下的代码变更，减少不必要的触发。
• Concourse 原生支持：符合 Concourse CI 资源规范，支持 check（检查变更）、in（获取代码）等标准操作。

使用场景和适用范围

• CI/CD 流水线触发：在 Concourse 流水线中作为 trigger 源，当 Mercurial 仓库有新提交时自动启动下游任务（如构建、测试、部署）。
• 代码变更监控：用于可视化或记录 Mercurial 仓库的提交历史，辅助团队追踪代码演进。
• 多仓库协同：在涉及多个 Mercurial 仓库的项目中，可通过多个资源实例分别监控不同仓库的变更。

使用方法和配置说明

资源类型定义

在 Concourse 流水线中使用前，需先定义资源类型（若未全局配置）：

yaml
resource_types:
- name: hg-resource
  type: docker-image
  source:
    repository: concourse/hg-resource  # 官方 Docker 镜像

资源配置

在流水线中定义具体资源时，需通过 source 字段配置 Mercurial 仓库信息：

yaml
resources:
- name: my-hg-repo
  type: hg-resource
  source:
    uri: https://example.com/path/to/repo  # Mercurial 仓库 URL（必填）
    branch: default                       # 跟踪的分支名称，默认为 "default"（可选）
    username: ((hg-username))             # 仓库认证用户名（私有仓库必填，可选）
    password: ((hg-password))             # 仓库认证密码（私有仓库必填，可选）
    paths:                                # 仅监控指定路径的变更（可选）
      - src/main/
      - docs/

配置参数说明

操作说明

Mercurial Resource 支持 Concourse 资源的标准生命周期操作：

1. check（检查变更）

• 功能：定期查询 Mercurial 仓库，返回最新提交的版本信息（变更集哈希）。
• 触发条件：Concourse 按配置的间隔自动执行，或通过流水线手动触发。

2. in（获取代码）

• 功能：将指定版本的代码从 Mercurial 仓库拉取到流水线工作目录。
• 使用场景：作为任务的输入，供后续构建、测试等操作使用。

3. out（推送代码，可选）

• 功能：部分资源支持将本地修改推送到 Mercurial 仓库（具体能力需参考官方文档）。

流水线示例

以下是一个完整的流水线示例，使用 Mercurial Resource 监控仓库变更并执行测试任务：

yaml
resource_types:
- name: hg-resource
  type: docker-image
  source: {repository: concourse/hg-resource}

resources:
- name: my-hg-repo
  type: hg-resource
  source:
    uri: https://hg.example.com/my-project
    branch: dev
    paths:
      - src/
    username: ((hg-user))
    password: ((hg-pass))

jobs:
- name: test-on-commit
  plan:
  - get: my-hg-repo
    trigger: true  # 仓库有新提交时自动触发任务
  - task: run-unit-tests
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: python, tag: 3.9}  # 使用 Python 镜像执行测试
      inputs:
      - name: my-hg-repo  # 将拉取的代码作为输入
      run:
        path: sh
        args:
        - -c
        - |
          cd my-hg-repo/src
          pip install -r requirements.txt
          pytest  # 执行测试命令

注意事项

• 网络可达性：确保 Concourse Worker 能够访问 Mercurial 仓库的 URL（需配置防火墙、代理等网络策略）。
• 认证方式：除 username/password 外，私有仓库也可通过 SSH 密钥认证（需在 source 中配置 private_key，具体参考官方文档）。
• 版本兼容性：建议使用最新版本的 concourse/hg-resource 镜像，以确保与 Mercurial 新版本和 Concourse 平台的兼容性。