diff --git a/.github/cliff.toml b/.github/cliff.toml
new file mode 100644
index 00000000..b8a6ab1f
--- /dev/null
+++ b/.github/cliff.toml
@@ -0,0 +1,95 @@
+[remote.github]
+owner = "GeWuYou"
+repo = "GFramework"
+
+[changelog]
+header = ""
+
+body = """
+{%- macro remote_url() -%}
+https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+
+{% macro has_release_highlight(commit) -%}
+{%- set highlighted = false -%}
+{%- if commit.remote and commit.remote.pr_labels -%}
+ {%- for label in commit.remote.pr_labels -%}
+ {%- if label == "release-highlight" or label == "highlight" -%}
+ {%- set highlighted = true -%}
+ {%- endif -%}
+ {%- endfor -%}
+{%- endif -%}
+{%- if not highlighted and commit.footers -%}
+ {%- for footer in commit.footers -%}
+ {%- if footer.token == "Release-Highlight" and footer.value | trim == "true" -%}
+ {%- set highlighted = true -%}
+ {%- endif -%}
+ {%- endfor -%}
+{%- endif -%}
+{{ highlighted }}
+{%- endmacro %}
+
+{% macro print_commit(commit) -%}
+- {{ commit.message | split(pat="\n") | first | trim | upper_first }}{% if commit.remote and commit.remote.username %} by @{{ commit.remote.username }}{% elif commit.author.name %} by {{ commit.author.name }}{% endif %}{% if commit.remote and commit.remote.pr_number %} in [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}){% endif %}
+{%- endmacro %}
+
+{% if version -%}
+## {{ version }} ({{ timestamp | date(format="%Y-%m-%d") }})
+{% else -%}
+## 未发布
+{% endif %}
+
+{% set highlights = commits | filter(attribute="breaking", value=true) %}
+{% for commit in commits -%}
+ {% if self::has_release_highlight(commit=commit) == "true" -%}
+ {% set_global highlights = highlights | concat(with=commit) -%}
+ {% endif -%}
+{% endfor -%}
+
+{% if highlights | length > 0 -%}
+## 重点条目
+{% for commit in highlights -%}
+{{ self::print_commit(commit=commit) }}
+{% endfor %}
+
+{% endif -%}
+
+{% for group, commits in commits | group_by(attribute="group") -%}
+### {{ group | striptags | trim }}
+{% for commit in commits -%}
+{{ self::print_commit(commit=commit) }}
+{% endfor %}
+
+{% endfor -%}
+
+{% if previous and previous.version and version -%}
+Full Changelog: [{{ previous.version }}...{{ version }}]({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})
+{% endif -%}
+"""
+
+footer = ""
+
+[git]
+conventional_commits = true
+filter_unconventional = true
+split_commits = false
+protect_breaking_commits = false
+sort_commits = "oldest"
+
+commit_parsers = [
+ { message = ".*\\[skip changelog\\].*", skip = true },
+ { body = ".*\\[skip changelog\\].*", skip = true },
+ { message = "^feat", group = "✨ 新功能" },
+ { message = "^fix", group = "🐛 Bug 修复" },
+ { message = "^perf", group = "⚡ 优化" },
+ { message = "^refactor", group = "⚡ 优化" },
+ { message = "^docs", group = "📝 文档/其他" },
+ { message = "^test", group = "📝 文档/其他" },
+ { message = "^chore", group = "📝 文档/其他" },
+ { message = "^build", group = "📝 文档/其他" },
+ { message = "^ci", group = "📝 文档/其他" },
+ { message = "^style", group = "📝 文档/其他" }
+]
+
+[git.github]
+commits = true
diff --git a/.github/workflows/auto-tag.yml b/.github/workflows/auto-tag.yml
index 4e6b6017..b48915ed 100644
--- a/.github/workflows/auto-tag.yml
+++ b/.github/workflows/auto-tag.yml
@@ -56,13 +56,27 @@ jobs:
echo "next_version=${{ steps.semantic_release.outputs.new_release_version }}"
echo "next_tag=${{ steps.semantic_release.outputs.new_release_git_tag }}"
+ - name: Generate preview release notes
+ if: ${{ steps.semantic_release.outputs.new_release_published == 'true' }}
+ id: cliff_preview
+ uses: orhun/git-cliff-action@v4
+ with:
+ config: .github/cliff.toml
+ args: >-
+ -vv --unreleased --strip header
+ --tag "${{ steps.semantic_release.outputs.new_release_git_tag }}"
+ env:
+ OUTPUT: PREVIEW_RELEASE_NOTES.md
+ GITHUB_REPO: ${{ github.repository }}
+ GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
+
- name: Write preview summary
env:
RELEASE_PUBLISHED: ${{ steps.semantic_release.outputs.new_release_published }}
- RELEASE_NOTES: ${{ steps.semantic_release.outputs.new_release_notes }}
+ CLIFF_RELEASE_NOTES: ${{ steps.cliff_preview.outputs.content }}
run: |
{
- echo "## Semantic Release Preview"
+ echo "## Release Preview"
echo
echo "- Commit: \`${{ github.sha }}\`"
echo "- Release needed: \`${{ steps.semantic_release.outputs.new_release_published }}\`"
@@ -71,13 +85,11 @@ jobs:
echo "- Next tag: \`${{ steps.semantic_release.outputs.new_release_git_tag }}\`"
echo "- Preview auth: uses \`PAT_TOKEN\` because semantic-release dry-run still performs a remote push permission probe."
echo "- Snapshot semantics: this preview is pinned to dispatch SHA \`${{ github.sha }}\`; commits added to \`main\` after the run starts are not included."
- if [ "${RELEASE_PUBLISHED}" = "true" ] && [ -n "${RELEASE_NOTES}" ]; then
+ if [ "${RELEASE_PUBLISHED}" = "true" ] && [ -n "${CLIFF_RELEASE_NOTES}" ]; then
echo
- echo "Preview release notes
"
+ echo "### 候选发布说明"
echo
- printf '%s\n' "${RELEASE_NOTES}"
- echo
- echo "Published release notes
"
+ echo "### 已发布说明"
echo
- printf '%s\n' "${RELEASE_NOTES}"
- echo
- echo "