candis/circleci

CANDIS CircleCI辅助镜像 ![CircleCI]([] ![Maintainability]([]

镜像概述

本镜像旨在简化与CircleCI 2.0的交互，并提供若干关于如何最佳运行CI流水线的建议。

使用方法

在CircleCI配置文件（.circleci/config.yml）中，将本镜像作为基础镜像使用：

yaml
docker:
  - image: candis/circleci:$VERSION

其中$VERSION为镜像版本，可在仓库的VERSION文件中获取。

核心功能

build_helm_package

用于打包Helm Chart的辅助命令，假设目录结构符合https://github.com/CandisIO/circleci/blob/master/scripts/commands/build_helm_package.sh%E6%8F%8F%E8%BF%B0%EF%BC%8C%E9%9C%80%E8%AE%BE%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%EF%BC%9A%60AWS_REGION%60%E3%80%81%60AWS_ACCESS_KEY_ID%60%E3%80%81%60AWS_SECRET_ACCESS_KEY%60%E3%80%81%60AWS_ECR_ACCOUNT_URL%60%E3%80%82

使用示例：

yaml
- run:
    name: 构建Helm包
    command: build_helm_package

build_push_image

用于构建镜像并推送到AWS ECR镜像仓库的辅助命令，假设仓库根目录存在Dockerfile，需设置环境变量：AWS_ACCOUNT_ID、AWS_REGION、AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY、AWS_ECR_ACCOUNT_URL；若需从私有GitHub npm仓库拉取依赖，还需设置GITHUB_ACCESS_TOKEN。

使用示例：

yaml
- run:
    name: 构建并推送Docker镜像到AWS ECR
    command: build_push_image

jira_notify

通过解析提交消息中的工单引用，向JIRA报告构建和部署状态。需设置环境变量CIRCLE_TOKEN（拥有CircleCI项目全权限的令牌），并启用JIRA集成（仓库设置→权限→JIRA集成，使用令牌方式）。

参数说明：

使用示例：

yaml
- run:
    name: 通知Jira新生产版本发布
    command: jira_notify
    environment:
      ENVIRONMENT_TYPE: 'production'
      JOB_TYPE: 'deployment'

security_check

运行自动化安全扫描工具，查找已知的JS/Node.js漏洞。

使用示例：

yaml
- run:
    name: 安全检查
    command: security_check

start_deployment_pipeline

通过API启动仓库的Spinnaker部署流水线，需确保platform-deployment上下文可用。

使用示例：

yaml
- run:
    name: 启动部署流水线
    command: start_deployment_pipeline

sync_spinnaker_config（已废弃，使用sync_infra_configs替代）

同步仓库的Spinnaker代码配置到运行中的Spinnaker部署，需确保platform-deployment上下文可用。

sync_infra_configs

基于服务_infra目录下的project.yaml文件，同步所有服务基础设施配置到相关工具（当前包括Spinnaker的应用和部署流水线配置），需确保platform-deployment上下文可用。

_infra/project.yaml字段说明：

示例project.yaml：

yaml
version: 1
name: service-foo-bar
description: 该服务负责处理foo和bar相关业务。
deployment_type: default

使用示例：

yaml
- run:
    name: 同步项目基础设施配置
    command: sync_infra_configs

tag_prod_release

标记新生产版本的辅助命令，当前包括将对应Docker镜像标记为latest，后续还会推送新Git标签。需设置环境变量：AWS_ACCESS_KEY_ID、AWS_DEFAULT_REGION、AWS_SECRET_ACCESS_KEY，可从service-boilerplate仓库导入这些变量。

使用示例：

yaml
- run:
    name: 标记生产版本
    command: tag_prod_release

使用场景

本镜像适用于CircleCI 2.0流水线中的以下场景：

1. 构建并打包Helm Chart
2. 构建Docker镜像并推送到AWS ECR
3. 向JIRA同步构建/部署状态
4. 执行JS/Node.js项目的安全漏洞扫描
5. 启动Spinnaker部署流水线
6. 同步基础设施配置到Spinnaker
7. 标记生产版本