hubci/hugo

HubCI: Hugo ![Build Status]([***]

镜像概述

HubCI: Hugo是一个针对Hugo（静态网站生成器）的Docker镜像，集成了https://github.com/gjtorikian/html-proofer%E6%B5%8B%E8%AF%95%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%89%98%E7%AE%A1%E4%BA%8Ehttps://hub.docker.com/r/hubci/hugo/%E3%80%82%E5%BD%93%E5%89%8D%E7%89%88%E6%9C%AC%E4%B8%BB%E8%A6%81%E8%AE%BE%E8%AE%A1%E4%B8%BACircleCI%E7%9A%84%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%9E%84%E5%BB%BA%E3%80%81%E6%B5%8B%E8%AF%95%E5%92%8C%E9%83%A8%E7%BD%B2%E5%9F%BA%E4%BA%8EHugo%E7%9A%84%E7%BD%91%E7%AB%99%EF%BC%8C%E6%9C%AA%E6%9D%A5%E8%AE%A1%E5%88%92%E6%89%A9%E5%B1%95%E6%94%AF%E6%8C%81%E6%9C%AC%E5%9C%B0%E6%B5%8B%E8%AF%95%E5%8F%8A%E5%85%B6%E4%BB%96CI%E5%B9%B3%E5%8F%B0%E3%80%82

核心功能与特性

• 集成工具链：包含Hugo静态网站生成器和HTMLProofer测试工具，一站式完成构建与测试
• CI优化：针对CircleCI环境优化，可直接作为基础镜像集成到CI流程
• 版本灵活：提供多种版本标签，满足不同场景需求（精确版本、次要版本、开发版、测试版）
• MIT许可：开源免费，基于MIT许可证分发

使用场景与适用范围

• CircleCI环境中构建、测试和部署Hugo静态网站
• 需要自动化测试静态网站链接及HTML有效性的场景
• Hugo网站项目的持续集成/持续部署（CI/CD）流程

使用方法与配置说明

在CircleCI上使用

在CircleCI中使用此镜像构建Hugo网站，只需在.circleci/config.yml中添加如下配置：

yaml
version: 2.1
jobs:
  build:
    docker:
      - image: hubci/hugo:0.96.0
    steps:
      - checkout
      - run:
          name: "运行Hugo构建"
          command: HUGO_ENV=production hugo -v -s src/
      - run:
          name: "测试网站"
          command: htmlproofer src/public --allow-hash-href --check-html --empty-alt-ignore --disable-external

配置说明：

• checkout：检出代码仓库
• 运行Hugo构建：设置环境变量HUGO_ENV=production，执行Hugo构建命令（-v显示详细日志，-s src/指定Hugo项目目录为src）
• 测试网站：使用HTMLProofer测试生成的静态文件（src/public），参数说明：
  • --allow-hash-href：允许哈希链接（如#anchor）
  • --check-html：验证HTML有效性
  • --empty-alt-ignore：忽略空alt属性
  • --disable-external：不检查外部链接

版本标签说明

构建镜像

生成Dockerfile

本地准备新镜像时，运行./shared/gen-dockerfiles.sh脚本并指定支持的Hugo版本，例如：

bash
./shared/gen-dockerfiles.sh 0.96.0

该命令会生成对应版本的Dockerfile和构建脚本。

发布镜像

正式发布时使用./shared/release.sh脚本，该脚本会调用gen-dockerfiles.sh并处理Git发布流程，提交信息中需包含[release]标记以触发发布。

使用此镜像的网站示例

以下网站基于Hugo构建并使用此镜像（部分提供公开配置）：

• <[]>（https://github.com/felicianotech/%5B]
• <[***]>（https://github.com/felicianotech/hugonewsletter.com%EF%BC%89
• <[***]>（https://github.com/felicianotech/docsthursday.com%EF%BC%89
• <[]>（https://github.com/discoursehub/%5B]
• https://unicef.github.io/inventory/%EF%BC%88https://github.com/unicef/inventory%EF%BC%89
• https://unicef.github.io/drone-4sdgtoolkit/%EF%BC%88https://github.com/unicef/drone-4sdgtoolkit%EF%BC%89

反馈与贡献

欢迎通过GitHub Issues提交问题、建议或bug报告，也可在Hugo论坛发帖并@FelicianoTech。Pull Request同样受欢迎。