@openstad/cms 实现镜像文档

镜像概述与主要用途

本镜像为@openstad/cms的实现版本，专为开放民主场景设计，提供内容管理系统功能，支持本地开发环境配置、依赖管理、CI/CD流程自动化及多环境部署，适用于开放民主相关平台的内容管理与全流程部署。

核心功能与特性

• 本地开发支持：提供.env环境变量配置、npm依赖管理及本地包链接功能，方便开发调试
• CI/CD集成：对接Travis CI实现Gitops流程，支持自动化测试、资产生成、Docker镜像构建与推送
• 多环境部署：支持开发（dev）、验收（acc）、生产（prod）多环境配置与部署管理

使用场景与适用范围

适用于开放民主相关平台的内容管理系统开发、测试与生产部署，尤其适合需要自动化CI/CD流程的开发团队，满足从本地开发到多环境生产部署的全流程管理需求。

前提条件

• Git
• Node.js 及 npm
• MongoDB

使用方法与配置说明

1. 环境变量配置

复制.env.example文件为.env并配置环境变量：

bash
cp .env.example .env
# 根据需求编辑.env文件设置环境变量值

2. 依赖安装

运行npm install安装项目依赖：

bash
npm i

3. 本地开发包链接

如需本地开发@openstad/cms包，执行以下链接步骤：

bash
# 进入cms包目录
cd packages/cms
# 创建本地链接
npm link
# 返回项目根目录
cd ../../
# 链接本地@openstad/cms包
npm link @openstad/cms

关于@openstad/cms包的详细信息，参见README

Travis CI Gitops配置

Gitops流程

Gitops自动化流程包括以下步骤：

1. 应用程序测试
2. 资产生成
3. Docker镜像构建
4. Docker镜像推送
5. 将新镜像版本提交至Helm仓库（基于GITOPS_RELEASE_BRANCH及各环境VALUES_FILE配置）

启用Gitops需配置的环境变量

如需在Travis CI流水线中启用Gitops流程，需配置以下环境变量：

• GITOPS=true：启用Gitops流程开关
• DOCKER_PUBLIC_USERNAME=openstad：Docker公共仓库用户名
• DOCKER_IMAGE_NAME=frontend：Docker镜像名称
• HELM_REPO_NAME=openstad-kubernetes：Helm仓库名称
• HELM_CHART_FOLDER=k8s/openstad：Helm图表文件夹路径
• GITOPS_RELEASE_BRANCH=master：Gitops发布分支
• GITOPS_DEV_VALUES_FILE=k8s/openstad/environments/dev.values.yaml：开发环境配置文件路径
• GITOPS_ACC_VALUES_FILE=k8s/openstad/environments/acc.values.yaml：验收环境配置文件路径
• GITOPS_PROD_VALUES_FILE=k8s/openstad/environments/prod.values.yaml：生产环境配置文件路径