Evidence项目GitHub Pages部署配置优化指南

在Evidence项目文档中关于GitHub Pages部署的配置示例存在一个常见问题，许多开发者在使用时会遇到构建目录路径错误的情况。本文将详细解释问题的根源以及正确的配置方法。

问题现象

当开发者按照官方文档配置GitHub Actions工作流时，构建步骤会报错提示"directory not found"。具体表现为：

1. 在构建步骤中设置了BASE_PATH环境变量
2. 在上传制品步骤中指定了包含仓库名称的构建路径
3. 但实际上构建产物并未生成在预期的子目录中

问题根源

这个问题源于对Evidence构建系统工作方式的理解偏差。Evidence项目在构建时确实支持通过BASE_PATH环境变量来配置基础路径，但这需要同时在package.json中进行相应的配置才能正常工作。

正确配置方案

方案一：简化配置（推荐）

对于大多数GitHub Pages部署场景，最简单的解决方案是：

1. 移除BASE_PATH环境变量设置
2. 直接上传整个build目录

- name: build
  run: |
    npm run sources
    npm run build

- name: Upload Artifacts
  uses: actions/upload-pages-artifact@v3
  with:
    path: './build'

方案二：完整basePath配置

如果需要使用basePath功能，必须同时在package.json中进行配置：

1. 首先修改package.json中的build脚本：

{
  "scripts": {
    "build": "evidence build --out=build/$REPO_NAME"
  }
}

2. 然后在GitHub Actions工作流中：

- name: build
  env:
    REPO_NAME: ${{ github.event.repository.name }}
    # 其他环境变量...
  run: |
    npm run sources
    npm run build

- name: Upload Artifacts
  uses: actions/upload-pages-artifact@v3
  with:
    path: 'build/${{ github.event.repository.name }}'

最佳实践建议

1. 对于简单的GitHub Pages部署，推荐使用方案一的简化配置
2. 只有在确实需要basePath功能时才使用方案二
3. 确保构建脚本和上传路径配置一致
4. 在本地开发环境测试构建结果后再提交到CI/CD流程

Evidence作为一个现代化的数据文档工具，其部署配置应当尽可能简洁明了。通过理解构建系统的工作机制，开发者可以避免常见的配置陷阱，实现顺畅的持续部署流程。