Hugo 变更日志主题

一个用于显示变更日志的 Hugo 主题

特性

• 使用 Spectre.css 构建（所有未使用的组件均已禁用）
• 分页
• 移动设备友好

如何安装

• 使用 --recursive 标志克隆存储库，因为该主题包含子模块

  git clone git@github.com:jsnjack/hugo-changelog-theme.git --recursive
  

• 使用 hugo extended 版本

工作流程

约定

• 在 experimental/ 文件夹中创建未发布的条目。 所有条目都显示在第一页的顶部
• 在 deprecated/ 文件夹中创建弃用条目。 弃用的条目显示在第一页顶部的下拉部分中
• 在 released/ 文件夹中创建已发布的条目。 条目按权重排序。权重显示为版本
• 您的 hugo 变更日志网站位于 site/changelog/ 文件夹中
• 您正在使用 master 分支作为稳定分支，使用 develop 分支作为工作分支（仅用于合并后 webhook）

脚本

• Makefile - 有用的命令列表
• release.py - 将更改从 experimental/ 文件夹移动到 released/ 文件夹，分配版本号并生成发布提交
• .githooks/post-merge - 验证从工作分支合并到稳定分支期间 experimental/ 文件夹是否为空

依赖项

• 用于发布脚本

   sudo pip install python-frontmatter
  

描述

1. 当拉取请求准备好时，开发人员会创建一个变更日志条目

   make change
   

   该命令在 site/changelog/content/experimental/ 文件夹中创建一个具有随机名称的 *.md 文件（确保不会发生合并冲突）

2. 如有必要，开发人员会创建一个弃用条目

   make deprecation
   

   该命令在 site/changelog/content/deprecated/ 文件夹中创建一个具有随机名称的 *.md 文件（确保不会发生合并冲突）。 请注意，弃用条目不会自动删除。 当某个弃用功能达到生命周期结束时，必须手动删除 deprecation/ 文件夹中对应的文件

3. 开发人员使用更改更新创建的文件。 更改将呈现在模板的 experimental 部分中

4. 使用命令预览站点

   make serve_changelog
   

5. 当工作分支准备好合并到稳定分支时，开发人员运行

   make release
   

   该命令会将所有 *.md 文件从 experimental/ 文件夹移动到 released/ 文件夹，分配发布版本并生成包含相关更改的提交

6. 开发人员将工作分支合并到稳定分支中

短代码

• {{< tag fixed >}} - 在条目文本之前创建一个特定的标签。 可用的标签类型有：added、changed、fixed、deprecated、removed、performance、security、self-hosted

设置

[params]
    customCSS = ["css/styles.css"]  # List of css files to include on the website. Relative to the static/ folder
    customJS = ["js/script.js"]     # List of js files to include on the website. Relative to the static/ folder

开发

运行示例网站

cd exampleSite && hugo serve --theme hugo-changelog-theme --themesDir ../../ --baseURL https://#/