Just-the-Docs项目GitHub Actions版本升级解决方案

背景介绍

2025年1月，GitHub官方宣布了一项重要变更：GitHub Pages Actions将要求使用Artifacts Actions v4版本。这一变更影响了许多基于Jekyll的文档站点项目，包括流行的Just-the-Docs主题。许多用户在不知情的情况下，其持续集成(CI)流程突然开始报错，特别是出现"Error: Missing download info for actions/upload-artifact@v3"的错误信息。

问题分析

该错误的核心原因是GitHub Actions工作流中使用的actions版本过时。在2025年1月之前，许多Just-the-Docs项目使用的是v3版本的actions，包括：

• actions/checkout@v3
• actions/configure-pages@v3
• actions/upload-pages-artifact@v2
• actions/deploy-pages@v2

GitHub在2025年1月后停止了对这些旧版本的支持，导致工作流无法正常运行。值得注意的是，仅仅升级actions版本而不更新Ruby版本是不够的，必须同时进行两项升级才能解决问题。

解决方案详解

1. 工作流文件修改

需要修改三个关键的工作流文件，它们位于项目根目录下的.github/workflows文件夹中：

ci.yml文件修改要点

• 将actions/checkout升级到v4版本
• 将Ruby版本从3.1升级到3.3

pages.yml文件修改要点

• actions/checkout升级到v4
• actions/configure-pages升级到v5
• actions/upload-pages-artifact升级到v3
• actions/deploy-pages升级到v4
• Ruby版本升级到3.3

jekyll.yml文件修改要点

• actions/checkout升级到v4
• actions/configure-pages升级到v4
• actions/deploy-pages升级到v4

2. 升级注意事项

1. 版本兼容性：必须同时升级actions和Ruby版本，单独升级其中一项无法解决问题
2. Dependabot限制：默认情况下，Dependabot不会自动检测GitHub Actions的版本更新，需要额外配置
3. 测试验证：修改后建议先在测试分支上验证工作流是否正常运行

技术建议

对于使用Just-the-Docs主题的项目维护者，建议：

1. 定期检查依赖：即使项目处于维护状态，也应定期检查关键依赖的更新情况
2. 启用Actions监控：配置Dependabot以监控GitHub Actions的版本更新
3. 文档更新：在项目文档中记录关键依赖的最低版本要求
4. 版本锁定：对于生产环境，考虑锁定actions和Ruby的特定版本，避免自动升级带来的意外问题

总结

GitHub基础设施的更新往往会影响依赖它的项目工作流。对于Just-the-Docs这样的文档生成项目，及时跟进GitHub Actions的版本要求至关重要。通过本文提供的解决方案，用户可以快速修复因actions版本过时导致的构建错误，确保文档站点的持续集成流程稳定运行。