emeraldsquad/artifactory-resource

Artifactory资源

Artifactory资源允许您将流水线作业与Artifactory中的Maven仓库集成。

概述和主要用途

该资源旨在实现Concourse流水线与JFrog Artifactory Maven仓库的无缝集成，支持制品的部署、检索以及基于制品版本更新的作业触发，满足CI/CD流程中的制品管理需求。

核心功能和特性

• 部署构建生成的制品和POM文件到Artifactory仓库
• 从Artifactory仓库检索指定制品
• 当制品有新版本可用时自动触发流水线作业
• 支持SNAPSHOT版本检测与处理
• 可上传构建信息至Artifactory

使用场景和适用范围

适用于需要在Concourse流水线中管理Maven制品的场景，包括但不限于：

• CI流程中构建产物的自动上传
• CD流程中依赖制品的获取
• 基于制品版本变更的自动部署触发
• 构建信息的追踪与管理

使用方法和配置说明

资源类型配置

yaml
resource_types:
  - name: artifactory
    type: registry-image
    source:
      repository: emeraldsquad/artifactory-resource
      tag: 3.3.0

源配置（Source Configuration）

必填参数

• host: 必需。包含上下文根的完整域名。
• api_key: 必需。具有目标仓库读写权限的用户API密钥。
• repository_id: 必需。仓库ID，可以是本地仓库或远程仓库（远程仓库仅支持check和in操作）。
• group_id: 必需。制品的Maven groupId。
• artifact_id: 必需。制品的Maven artifactId。

可选参数

• version: 可选。检索特定版本的制品。
• enforce_semver: 可选。仅使用语义化版本。默认值：false。
• show-debug: 可选。使日志更详细。默认值：false。
• artifact-size.pattern: 可选。日志详细模式。默认值：*。
• artifact-size.output: 可选。输出方式，log或metadata。默认值：空。

配置示例

制品资源配置

yaml
resources:
  - name: my-artifact
    type: artifactory
    source:
      api_key: <API密钥>
      host: https://emerald.squad.com/artifactory
      repository_id: repo
      group_id: emerald.squad
      artifact_id: wonderful-artifact
      enforce_semver: true

检索制品

yaml
- get: my-artifact

yaml
- get: my-artifact
  params:
    qualifiers: [sources, javadoc]  # 检索带分类器的制品

yaml
- get: my-artifact
  params:
    qualifiers: [archive]
    extract_pattern: ['*-archive.tar.gz']  # 提取匹配的归档文件

yaml
- get: my-artifact
  params:
    version: 1.0.0-rc.1  # 检索特定版本

推送制品到（本地）仓库

yaml
- put: my-artifact
  params:
    path: artifacts  # 制品所在路径

发布构建信息（使用默认参数）

yaml
- put: my-artifact
  params:
    path: artifacts
    build_upload: true  # 启用构建信息上传

发布构建信息（使用所有可选参数）

yaml
- put: my-artifact
  params:
    path: artifacts
    build_upload: true
    build_publish:
      build_name: wonderful-artifact-build  # 构建名称
      git_url: <Git URL>  # 代码仓库URL
      git_rev: artifacts/revision  # Git修订版本
      env_include: "BUILD|ATC"  # 包含的环境变量模式
      env_exclude: "API_KEY"  # 排除的环境变量模式

行为说明

通用行为（check、in 和 out）

• SNAPSHOT处理：

  • 检测x.x.x-SNAPSHOT格式的Maven元数据SNAPSHOT
  • 从maven-metadata.xml中检测构建号和时间戳
  • 检测x.x.x-[TIMESTAMP_SNAPSHOT]-[BUILD_NUMBER_SNAPSHOT]*格式的文件路径

• 远程仓库行为：

  • 若仓库是远程仓库的缓存（名称以-cache结尾），仅检测通过复制等方式缓存的版本
  • 若仓库是远程仓库（名称不以-cache结尾），检测远程仓库中所有版本（无论是否缓存）

check：检查新制品

资源在http(s)://<host>/<repository_id>/<group_id>/<artifact_id>路径下搜索文件夹，期望获取有效的Maven版本列表（详见Maven版本规范）。返回给定引用的所有后续版本；若未提供版本，仅返回最新版本。

in：下载指定引用的制品

将指定引用的制品下载到目标位置，返回与输入相同的引用作为版本。成功时生成包含Concourse元数据的metadata.json，可通过load_var步骤访问。

参数

• qualifiers: 可选。制品分类器，例如[source, javadoc]。指定后将检索无分类器制品和指定分类器制品；默认仅检索无分类器制品和版本。
• extract_pattern: 可选。归档文件或JAR的Glob提取模式，例如['*.tar.gz']。指定后将提取匹配的归档文件。
• version: 可选。检索特定版本的制品（覆盖source.version）。

out：推送制品到仓库

将指定路径下的制品推送到Artifactory Maven仓库。资源会推送path参数指定文件夹中的所有文件。版本参数可选，但资源至少需要一个包含有效Maven版本的版本文件（详见Maven版本规范）。

通过将build_upload设为true可选择上传构建信息。资源会生成build.json文件并上传至Artifactory。构建名称默认为<source.artifact_id>-build，构建号设为Concourse的$BUILD_ID元数据值。

若为SNAPSHOT版本，将检测Maven在Artifactory上生成的路径以生成相应引用。

参数

• path: 必需。要推送到仓库的文件路径。
• version: 可选。版本文件路径，若文件不存在则直接作为版本使用。默认为<path参数>/version。
• build_upload: 可选。是否上传构建信息。默认值：false。
• build_publish: 可选。上传构建信息的参数：
  • build_name: 可选。构建名称。默认为<source.artifact_id>-build。
  • git_url: 可选。以下之一：
    • 制品源代码的Git URL
    • 包含制品源代码Git URL的文件路径
  • git_rev: 可选。以下之一：
    • 制品源代码的Git修订版本
    • 包含制品源代码Git修订版本的文件路径
  • env_include: 可选。以"pattern1|pattern2|..."形式的不区分大小写的模式列表，仅包含匹配的环境变量。默认值："."。
  • env_exclude: 可选。以"pattern1|pattern2|..."形式的不区分大小写的模式列表，排除匹配的环境变量。默认值："password|pword|pwd|secret|key|token"。