CI

GitHub Actions 配置指南

要在 GitHub Actions 中启用 Prettier 自动修复功能，请按以下步骤操作：

  1. 安装 https://github.com/apps/autofix-ci GitHub 应用
  2. 固定 Prettier 版本（确保仓库中安装的是特定版本）
  3. 创建 .github/workflows/prettier.yml 文件，内容如下：
# .github/workflows/prettier.yml
name: autofix.ci          # 工作流名称
on:                       
  pull_request:           # 触发条件：PR创建/更新时
  push:                   # 触发条件：代码推送时
permissions: {}           # 默认权限（空对象表示不赋予额外权限）
jobs:
  prettier:
    runs-on: ubuntu-latest # 使用最新版Ubuntu系统
    steps:
      # 检出代码
      - uses: actions/checkout@v4  
      # 配置Node.js环境
      - uses: actions/setup-node@v4  
      # 执行格式化操作
      - run: |             
          yarn            # 安装依赖
          yarn prettier . --write  # 执行Prettier格式化当前目录
      # 自动提交格式化后的代码
      - uses: autofix-ci/action@v1  
        with:
          commit-message: "Apply Prettier format"  # 自动提交的说明文案

更多配置详见 https://autofix.ci/。

总结说明

  1. 核心流程：
    安装GitHub应用 → 固定Prettier版本 → 配置工作流文件
  2. 自动化机制：
    • 监听 pull_request 和 push 事件自动触发
    • 使用 yarn prettier --write 执行格式化
    • 通过 autofix-ci 自动提交格式化后的代码
  3. 关键注意：
    • 必须锁定Prettier版本保证格式一致性
    • 权限配置 permissions: {} 表示使用基础权限
    • 提交信息可自定义修改
最后更新: