xgj/release-web/README.md

# Web 项目发布构建 Action

[![GitHub](https://img.shields.io/badge/github-actions-blue.svg)](https://github.com/features/actions)

自动化 Web 项目发布流程的 GitHub Action，专注于版本管理和发布核心功能，智能处理各种版本格式。

## 功能特性

- 🚀 **自动化发布**: 支持任意发布命令进行版本管理和发布
- 🌍 **环境变量支持**: 支持传递任意数量的环境变量给发布命令
- 📦 **智能版本处理**: 自动获取版本号，确保输出格式一致（无 `v` 前缀）
- 🔧 **简洁配置**: 最小化配置，专注于发布核心功能
- ✅ **灵活使用**: 可配置发布命令，适应不同项目需求

## 快速开始

### 基础用法

```yaml
- name: 发布Web项目
  uses: actions/xgj/release-web@main
  env:
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
```

### 使用环境变量

```yaml
- name: 发布Web项目
  uses: actions/xgj/release-web@main
  env:
    # 🌍 可以传递任意数量的环境变量给发布命令
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
    APP_ENV: production
    SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
    SENTRY_DSN: ${{ vars.SENTRY_DSN }}
    SENTRY_VITE: true
    BUILD_NUMBER: ${{ github.run_number }}
    CUSTOM_CONFIG: "your-value"
    FEATURE_FLAG: ${{ github.ref == 'refs/heads/main' }}
    # ... 更多任意环境变量
```

### 完整示例

```yaml
- name: 发布Web项目
  uses: actions/xgj/release-web@main
  with:
    release-command: "npm run release -- --release -V"
  env:
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
    APP_ENV: "production"
    SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
    SENTRY_DSN: ${{ vars.SENTRY_DSN }}
    SENTRY_VITE: "true"
```

### 自定义版本文件路径

```yaml
- name: 发布Web项目
  uses: actions/xgj/release-web@main
  with:
    version-file: "./dist/version.txt" # 自定义版本文件位置
  env:
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
```

### 版本格式处理

Action 自动处理各种版本格式，确保输出一致：

```yaml
# 输入可能的格式：
# - 版本文件: "v1.2.3" 或 "1.2.3"
# - Git tag: "v1.2.3" 或 "1.2.3"
# - package.json: "v1.2.3" 或 "1.2.3"
# - 提交信息: "release: v1.2.3" 或 "release: 1.2.3"

# 输出始终为: "1.2.3" (不含 v 前缀)
```

## 输入参数

| 参数名            | 描述                      | 必需 | 默认值                            |
| ----------------- | ------------------------- | ---- | --------------------------------- |
| `release-command` | 发布命令                  | ❌   | `npm run release -- --release -V` |
| `node-debug`      | 是否启用 Node.js 调试模式 | ❌   | `false`                           |
| `version-file`    | 自定义版本文件路径        | ❌   | `/tmp/last-version`               |

## 环境变量支持

Action 支持通过 `env` 传递**任意数量**的环境变量给发布命令，这些环境变量会自动传递给 `npm run release` 或其他发布命令：

```yaml
- uses: actions/xgj/release-web@main
  env:
    # 🌍 任意环境变量都会自动传递给发布命令
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
    APP_ENV: production
    SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_TOKEN }}
    CUSTOM_VAR: "your-value"
    BUILD_NUMBER: ${{ github.run_number }}
    FEATURE_FLAG: ${{ github.ref == 'refs/heads/main' }}
    # ... 更多任意变量
```

### 常用环境变量示例

| 环境变量名          | 描述             | 示例值                        |
| ------------------- | ---------------- | ----------------------------- |
| `GITEA_TOKEN`       | Gitea 访问令牌   | `${{ secrets.GITEA_TOKEN }}`  |
| `APP_ENV`           | 应用环境         | `production`                  |
| `SENTRY_AUTH_TOKEN` | Sentry 认证令牌  | `${{ secrets.SENTRY_TOKEN }}` |
| `SENTRY_DSN`        | Sentry DSN 配置  | `${{ vars.SENTRY_DSN }}`      |
| `SENTRY_VITE`       | 是否启用 Sentry  | `true`                        |
| `NODE_DEBUG`        | Node.js 调试模式 | `release-it:*`                |
| `BUILD_NUMBER`      | 构建编号         | `${{ github.run_number }}`    |

## 输出参数

| 参数名              | 描述                     |
| ------------------- | ------------------------ |
| `version`           | 发布的版本号             |
| `version-with-dash` | 版本号（点号替换为横线） |

## 使用场景

### 1. 基础发布流程

适用于简单的 Web 项目发布：

```yaml
steps:
  - uses: actions/checkout@v4

  - name: 设置环境
    uses: actions/xgj/setup-env@main
    with:
      docker-password: ${{ secrets.DOCKER_PASSWORD }}

  - name: 安装依赖
    uses: actions/xgj/npm-install@main

  - name: 发布项目
    uses: actions/xgj/release-web@main
    env:
      GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
```

### 2. 完整 CI/CD 流程

包含完整的构建、测试、发布流程：

```yaml
steps:
  - uses: actions/checkout@v4

  - name: 设置构建环境
    uses: actions/xgj/setup-env@main
    with:
      docker-password: ${{ secrets.DOCKER_PASSWORD }}
      kube-config: ${{ secrets.KUBE_CONFIG }}

  - name: 安装依赖
    uses: actions/xgj/npm-install@main
    with:
      package-manager: "pnpm"

  - name: 运行测试
    run: npm run test

  - name: 发布构建
    id: release
    uses: actions/xgj/release-web@main
    env:
      GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
      APP_ENV: ${{ github.ref == 'refs/heads/main' && 'production' || 'staging' }}
      SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
      SENTRY_DSN: ${{ vars.SENTRY_DSN }}
      SENTRY_VITE: "true"

  - name: 部署到Kubernetes
    run: |
      kubectl set image deployment/web-app web-app=docker-registry.bjxgj.com/${{ github.event.repository.name }}:${{ steps.release.outputs.version }}
```

### 3. 多环境发布

支持不同环境的差异化配置：

```yaml
strategy:
  matrix:
    environment: [staging, production]
    include:
      - environment: staging
        dockerfile: "./container/dev/Dockerfile"
        app-env: "staging"
      - environment: production
        dockerfile: "./container/prod/Dockerfile"
        app-env: "production"

steps:
  - name: 发布到 ${{ matrix.environment }}
    uses: actions/xgj/release-web@main
    env:
      GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
      APP_ENV: ${{ matrix.app_env }}
```

## 工作流程

1. **发布构建**: 执行指定的发布命令进行版本发布
2. **智能版本获取**: 通过多种方法自动获取版本号
   - 优先从版本文件读取（`/tmp/last-version` 或自定义路径）
   - 回退到最新 git tag（自动去除 `v` 前缀）
   - 回退到 `package.json` 中的版本
   - 最后尝试从提交信息解析（支持 `v1.2.3` 和 `1.2.3` 格式）
   - **所有方法都确保输出不包含 `v` 前缀**
3. **发布总结**: 输出发布信息和结果

## 依赖要求

### 项目要求

- 包含 `package.json` 文件（用于版本回退）
- 配置了发布工具（如 `release-it`）
- 包含发布脚本（如 `npm run release`）
- 推荐发布命令生成版本文件到 `/tmp/last-version`（或自定义路径）

### 环境依赖

- Node.js 环境
- npm/pnpm/yarn 包管理器
- 配置好的 Gitea 访问权限

## 配置示例

### release-it 配置

确保项目中有类似的 `.release-it.js` 配置：

```javascript
module.exports = {
  hooks: {
    "before:release": [
      "echo '${version}' > /tmp/last-version",
      "npm run build",
    ],
  },
  git: {
    tagName: "v${version}",
    commitMessage: "chore: released version v${version} [no ci]",
  },
  npm: {
    publish: false,
  },
};
```

### Docker 多阶段构建

推荐使用多阶段构建优化镜像大小：

```dockerfile
# 构建阶段
FROM node:18-alpine AS builder
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production

# 运行阶段
FROM node:18-alpine
WORKDIR /app
COPY --from=builder /app/node_modules ./node_modules
COPY dist ./dist
EXPOSE 3000
CMD ["npm", "start"]
```

## 错误处理

Action 会在以下情况报错并退出：

- 缺少必需的 `gitea-token` 参数
- 指定的 `Dockerfile` 不存在
- `/tmp/last-version` 文件不存在（发布命令未正确执行）
- Docker 构建失败

## 安全注意事项

- 🔒 始终通过 `secrets` 传递敏感令牌
- 🔍 定期检查和轮换访问令牌
- 📋 限制 Docker 仓库访问权限
- 🚫 避免在日志中暴露敏感信息

## 故障排除

### 常见问题

### Q: 无法获取版本信息

```bash
❌ 错误: 无法获取版本信息
```

A: Action 会按优先级尝试多种方法获取版本：

1. **版本文件** (推荐)：确保发布命令创建版本文件

   ```javascript
   // .release-it.js
   hooks: {
     'before:release': ['echo \'${version}\' > /tmp/last-version']
   }
   ```

2. **Git Tags**：确保发布过程创建了 git tag

   ```bash
   git tag v1.2.3
   ```

3. **package.json**：确保 package.json 包含有效的 version 字段

   ```json
   {
     "version": "1.2.3"
   }
   ```

4. **提交信息**：在提交信息中包含版本号

   ```bash
   git commit -m "release: 1.2.3"
   # 或者
   git commit -m "release: v1.2.3"
   ```

### Q: Gitea Token 权限不足

A: 确保 token 具有以下权限：

- Repository 写权限
- Releases 创建权限

### 调试模式

启用详细调试信息：

```yaml
- uses: actions/xgj/release-web@main
  with:
    node-debug: "true"
  env:
    GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
```

## 更新日志

查看 [Releases](https://github.com/your-org/actions/releases) 获取详细的更新历史。

## 贡献

欢迎提交 Issue 和 Pull Request 来改进这个 Action！

## 许可证

MIT License - 详见 [LICENSE](../LICENSE) 文件。