使用 GitHub Actions 自动部署 Hugo 网站教程

使用 GitHub Actions 自动部署 Hugo 网站教程

actions-hugoGitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.项目地址:https://gitcode.com/gh_mirrors/ac/actions-hugo

项目介绍

actions-hugo 是一个 GitHub Actions 工作流模板，专为使用 Hugo 静态站点生成器的项目设计。它极大地简化了网站构建和部署的过程，使得开发者能够自动地在每次代码推送后更新他们的 Hugo 站点到指定的服务器或者托管服务上，无需手动干预。

项目快速启动

环境需求

确保你的 Hugo 站点已配置好，并且有一个基本的 config.toml（或支持的其他配置文件）以及站点源码存储在 GitHub 上。

步骤说明

1. 克隆仓库（如果你还没有一个基于 Hugo 的项目）

   git clone https://github.com/<your_username>/<your_project>.git
   

2. 添加 .github/workflows 目录

   • 在你的项目根目录下创建 .github 文件夹（如果不存在），然后在其内创建一个名为 workflows 的子目录。

3. 配置 GitHub Actions

   • 复制 actions-hugo 提供的示例工作流文件到你的 .github/workflows 中，例如你可以直接从 这里 拷贝适合你场景的 .yml 文件。
   • 编辑该 .yml 文件以匹配你的项目需求，比如修改 hugo 版本、部署分支等。

name: Deploy with Hugo
 
on:
  push:
    branches:
      - master # 或者你想触发的分支
 
jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Setup Hugo
      uses: peaceiris/actions-hugo@v2
      with:
        hugo_version: '0.78.2'
        extended: true
    - name: Build Site
      run: hugo
    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./public

4. 提交并推送到 GitHub

   git add .github/workflows/hugo-deploy.yml
   git commit -m "Add GitHub Actions for automatic Hugo deployment"
   git push origin main # 或你的主分支
   

完成上述步骤后，每当向指定分支推送更改时，GitHub Actions 将自动构建你的 Hugo 站点并将结果部署到你的 GitHub Pages 或其他指定的部署目标。

应用案例和最佳实践

• 持续集成: 结合 GitHub Actions，确保每一次代码改动都经过构建验证，保持高质量的网站内容。
• 多环境部署: 可通过条件分支和环境变量实现开发、测试、生产环境的差异化部署。
• 静态资源优化: 利用 Hugo 内置功能和其他工具对生成的 HTML 和资产进行压缩，提升加载速度。

典型生态项目

虽然直接指出特定的“典型生态项目”可能需要考虑具体上下文，但使用 Hugo 配合 GitHub Actions 的项目广泛存在于个人博客、企业官网、技术文档站点中。一些开源项目如 Docsy —— 一个为技术文档打造的主题，经常结合 GitHub Actions 实现自动化文档发布，是Hugo生态中的一个亮点，展示了其在文档管理和自动化部署方面的强大能力。

通过实施类似的工作流程，任何基于 Hugo 的项目都能享受到高效、自动化的部署优势，简化运维复杂度。

actions-hugoGitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.项目地址:https://gitcode.com/gh_mirrors/ac/actions-hugo