ackee/gitlab-ci-utils

Gitlab CI Utils 镜像文档

镜像概述和主要用途

该镜像为GitLab CI流水线提供了多个实用脚本，主要用于GitLab API调用及CloudFlare相关操作，帮助优化CI流程中的等待机制和域名管理任务。

核心功能和特性

• 等待其他流水线完成：通过GitLab API监控并等待合并请求中的其他流水线结束
• 等待运行时资源：等待项目中其他流水线完成，适用于并发数大于1的Runner环境
• CloudFlare记录添加：通过CloudFlare API注册域名记录
• CloudFlare缓存清除：通过CloudFlare API按URL清除缓存

使用场景和适用范围

• GitLab CI流水线中需要协调多个并行流水线执行顺序的场景
• 需在CI流程中自动管理CloudFlare域名记录的场景
• 需要在CI过程中清除特定URL的CloudFlare缓存的场景

详细使用方法和配置说明

1. wait_for_other_pipelines_to_finish.sh

功能

等待合并请求中的其他独立流水线完成。

使用示例

yml
wait for all pipelines results:
  stage: wait
  image: docker.xuanyuan.run/beranm14/gitlab-ci-utils:latest
  script:
    - wait_for_other_pipelines_to_finish.sh

所需环境变量

• SECRET_GITLAB_ACCESS_TOKEN：能够访问GitLab API的令牌

2. wait_for_runtime.sh

功能

当Runner并发数大于1时，等待项目中其他流水线完成，确保后续任务可以继续执行。

使用示例

yml
wait for runtime:
  stage: wait
  image: docker.xuanyuan.run/beranm14/gitlab-ci-utils:latest
  script:
    - wait_for_runtime.sh

所需环境变量

• SECRET_GITLAB_ACCESS_TOKEN：能够访问GitLab API的令牌

3. cf_add_record.sh

功能

通过指定变量在CloudFlare上注册域名记录。

使用示例

yml
add cf record:
  stage: wait
  image: docker.xuanyuan.run/beranm14/gitlab-ci-utils:latest
  script:
    - cf_add_record.sh

所需环境变量

• DOMAIN_ZONE_ID：CloudFlare区域ID
• DOMAIN_KEY：CloudFlare访问令牌
• DOMAIN_EMAIL：CloudFlare访问***
• DOMAIN_CONTENT：记录内容，例如 c.storage.googleapis.com
• DOMAIN_NAME：记录名称，例如 myapp

可选环境变量

• DOMAIN_RECORD_TYPE：记录类型，默认为 CNAME

4. cf_purge_by_url.sh

功能

通过指定URL列表清除CloudFlare缓存。

使用示例

yml
clear cache by url:
  stage: wait
  image: docker.xuanyuan.run/beranm14/gitlab-ci-utils:latest
  script:
    - cf_purge_by_url.sh

所需环境变量

• DOMAIN_ZONE_ID：CloudFlare区域ID
• DOMAIN_KEY：CloudFlare访问令牌
• DOMAIN_EMAIL：CloudFlare访问***
• PURGE_URL：待清除缓存的URL列表，各URL需用逗号分隔并放在双引号中，例如：PURGE_URL='"https://example.com/index.html", "https://example.com/abc.js", "https://example.com/cba.js"'