From 4ff008e564de17f79c31137f305b9130f0c291c0 Mon Sep 17 00:00:00 2001 From: KenanZhu <3471685733@qq.com> Date: Wed, 23 Sep 2026 14:02:59 +0800 Subject: [PATCH] docs: clarify Gitea 1.27.3 fix is on main, not yet released --- AGENTS.md | 2 +- COMPATIBILITY.md | 14 +++++++------- README.md | 6 +++--- docs/README.zh-CN.md | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index e21dc59..435f972 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -67,7 +67,7 @@ docs/ # Bilingual documentation (English + Simplified Chinese) ## Versioning - Release tags identify actual downloadable packages; the compatibility matrix distinguishes released tags from source-only fixes -- The current published release is **v1.27.2**; it has a push-notification bug in Bloom, Ember, and Heritage on Gitea 1.27.1+. The current source tree fixes it and is verified against Gitea 1.27.3. The quick-reference table in `COMPATIBILITY.md` lists the unreleased row first; the tracker workflow updates that row by position +- The current published release is **v1.27.2**; it has a push-notification bug in Bloom, Ember, and Heritage on Gitea 1.27.1+. The fix is on `main` and verified against Gitea 1.27.3. The quick-reference table in `COMPATIBILITY.md` lists the `main (unreleased)` row first; the tracker workflow updates that row by position - When a new Gitea version is checked: update the top `COMPATIBILITY.md` row and README badge; keep unreleased fixes distinct from the published release, and update verified/tested wording only after verification - Tag a new release (`vX.Y.Z`) only when the template content itself changes — the release workflow packages automatically on tag push - Keep the `TRACKER:` markers in `COMPATIBILITY.md` / `README.md` adjacent to their rows so the automated workflow keeps parsing them diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index 8376d30..0156493 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -7,25 +7,25 @@ This document tracks the compatibility between **Gitea Mail Templates** releases | Template Release | Min Gitea | Max Tested Gitea | Status | |-----------------|-----------|-----------------|--------| -| **Unreleased** | **1.25.0** | **1.27.3** | ✅ Source verified; release pending | +| **main (unreleased)** | **1.25.0** | **1.27.3** | ✅ Fix pushed and verified; release pending | | **v1.27.2** | **1.25.0** | **1.27.3** | ⚠️ Push notices fail in Bloom, Ember, and Heritage on Gitea 1.27.1+ | | **v1.0.1** | **1.25.0** | **1.27.0** | ✅ Superseded; push notices need newer release on 1.27.1+ | | **v1.0.0** | **1.25.0** | **1.26.4** | ✅ Superseded | -> **Latest verified:** The current source tree passes the Gitea 1.27.3 source audit and push-render test. The published v1.27.2 archive still contains three broken push-notification templates. +> **Latest verified:** The fix on `main` passes the Gitea 1.27.3 source audit and push-render test; [CI passed](https://github.com/KenanZhu/GiteaMailTemplates/actions/runs/35824718700). The published v1.27.2 archive still contains three broken push-notification templates. ## Versioning -The release tag identifies the downloadable template package. The supported Gitea version may be appended in parentheses in this compatibility matrix; the parenthesized version is not a Git tag. An **Unreleased** row describes fixes in the source tree that are not yet in a downloadable release. +The release tag identifies the downloadable template package. The supported Gitea version may be appended in parentheses in this compatibility matrix; the parenthesized version is not a Git tag. A **main (unreleased)** row describes fixes available in the repository but not yet in a downloadable release. | Gitea version | Template release | |---------------|------------------| -| 1.27.3 | **Unreleased fix**; published v1.27.2 has a push-notification issue in three themes | -| 1.27.2 | **Unreleased fix**; published v1.27.2 has the same issue | -| 1.27.1 | **Unreleased fix**; published v1.27.2 has the same issue | +| 1.27.3 | **main (unreleased)**; published v1.27.2 has a push-notification issue in three themes | +| 1.27.2 | **main (unreleased)**; published v1.27.2 has the same issue | +| 1.27.1 | **main (unreleased)**; published v1.27.2 has the same issue | - The [tracker workflow](.github/workflows/gitea-tracker.yml) opens a PR when a new Gitea release appears, marking it ⏳ Pending Verification. -- After verification, update the top **Template Release** row. Keep source-only fixes marked **Unreleased** until a new tag is published; the [release workflow](.github/workflows/release.yml) packages the archive on tag push. +- After verification, update the top **Template Release** row. Keep fixes on `main` marked **unreleased** until a new tag is published; the [release workflow](.github/workflows/release.yml) packages the archive on tag push. - The older `v1.0.1` tag predates the Gitea 1.27.1 push notification data fix and should not be used for Gitea 1.27.1 or newer. ## Check Your Gitea Version diff --git a/README.md b/README.md index 02a56e1..f37870b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A curated collection of professionally designed, audience-driven email templates [![Gitea](https://img.shields.io/badge/Gitea-1.25+%20%7C%201.27.3%20tested-blue)](COMPATIBILITY.md) -> **110 template files — 10 visual styles, 11 email types each. Current source verified with Gitea 1.27.3; push-notification fixes await a new release.** +> **110 template files — 10 visual styles, 11 email types each. The `main` branch is verified with Gitea 1.27.3; push-notification fixes await a new release.** --- @@ -12,7 +12,7 @@ A curated collection of professionally designed, audience-driven email templates Most self-hosted Gitea instances use the default plain email templates. This project provides **ready-to-deploy, visually polished alternatives** — each designed for a specific community or audience, so you can pick the one that feels right for your users. -Every template is a drop-in replacement. All Go template variables, translation keys, and Gitea data contexts are fully compatible. **No patches, no plugins, no forks required.** +The templates on `main` can replace Gitea's built-in mail templates without patches, plugins, or forks. Check the [compatibility matrix](COMPATIBILITY.md) before using a published archive; older releases may have version-specific limitations. --- @@ -165,7 +165,7 @@ gitea-mail-templates/ - **Gitea 1.25+** — matches the refactored mail template directory structure (v1.25) - **Latest tested:** Gitea 1.27.3 -- **Published release:** v1.27.2. Its Bloom, Ember, and Heritage push notifications can fail on Gitea 1.27.1+; the fix is in the current source tree and awaits release (see [COMPATIBILITY.md](COMPATIBILITY.md)) +- **Published release:** v1.27.2. Its Bloom, Ember, and Heritage push notifications can fail on Gitea 1.27.1+; the fix is on `main` and awaits release (see [COMPATIBILITY.md](COMPATIBILITY.md)) - The current source uses Gitea's official template data paths — see [COMPATIBILITY.md](COMPATIBILITY.md) for release-specific limitations - Uses only built-in Gitea template functions and official translation keys - No custom template functions or locale patches required diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md index 02d3e48..125550f 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -10,7 +10,7 @@ 大多数自托管 Gitea 实例使用默认的纯文本邮件模板。本项目提供了**开箱即用、视觉精美的替代方案**——每种方案都针对特定社区或受众设计，您可以选择最适合您用户的风格。 -每个模板都是直接替换。所有 Go 模板变量、翻译键和 Gitea 数据上下文完全兼容。**无需补丁、无需插件、无需 fork。** +`main` 分支中的模板可直接替换 Gitea 内置邮件模板，**无需补丁、插件或 fork**。使用已发布的压缩包前，请先查看[兼容性说明](../COMPATIBILITY.md)，了解旧版本的限制。 --- @@ -80,7 +80,7 @@ cd tools && go run . dev - **Gitea 1.25+** — v1.25 引入的邮件模板目录结构 - **最新测试：** Gitea 1.27.3 -- **发布状态：** 已发布的 v1.27.2 在 Gitea 1.27.1+ 上，Bloom、Ember、Heritage 主题的推送通知可能失败；当前源码已修复，尚待发布（详见 [兼容性说明](../COMPATIBILITY.md)） +- **发布状态：** 已发布的 v1.27.2 在 Gitea 1.27.1+ 上，Bloom、Ember、Heritage 主题的推送通知可能失败；修复已推送到 `main`，尚待发布（详见 [兼容性说明](../COMPATIBILITY.md)） - 当前源码使用 Gitea 官方模板的数据路径；各发布版的限制详见 [兼容性说明](../COMPATIBILITY.md) ## 许可证