From a4ba20418c75c9c9f38752918ed30ef84e014a14 Mon Sep 17 00:00:00 2001 From: KenanZhu <3471685733@qq.com> Date: Mon, 24 Aug 2026 12:01:46 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20track=20Gitea=201.27.2=20=E2=80=94=20ve?= =?UTF-8?q?rified=20compatible=20(annotation=20versioning)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Gitea 1.27.2 (2026-08-14, security + bugfix release) contains no mail template changes — verified against the local gitea clone: only modules/templates/util_render.go (avatar-stack UI fix) differs from 1.27.1, templates/mail and services/mailer are untouched. Versioning now uses the annotation scheme: release numbers stay on the project's own scheme and the supported Gitea version is appended in parentheses — v1.0.1(v1.27.2). Synced everywhere: - COMPATIBILITY.md: active row v1.0.1(v1.27.2), latest verified 1.27.2, Versioning section reworded, 1.27.2 history row added - README.md / docs/README.zh-CN.md: badge, release line, latest tested, versioning bullets - AGENTS.md: annotation scheme + current release v1.0.1 (tracks 1.27.2) - gitea-tracker.yml: PR checklist now updates the parenthesized Gitea version instead of bumping the release number; new tags only when template content changes - CONTRIBUTING.md: simplified Translations section The local v1.27.1 tag was removed — it conflicts with the annotation scheme; releases keep v1.0.x tags. Co-Authored-By: Claude --- .github/workflows/gitea-tracker.yml | 9 +++++---- AGENTS.md | 9 +++++---- COMPATIBILITY.md | 15 ++++++++------- CONTRIBUTING.md | 2 -- README.md | 8 ++++---- docs/README.zh-CN.md | 4 ++-- 6 files changed, 24 insertions(+), 23 deletions(-) diff --git a/.github/workflows/gitea-tracker.yml b/.github/workflows/gitea-tracker.yml index eecb16f..28202e5 100644 --- a/.github/workflows/gitea-tracker.yml +++ b/.github/workflows/gitea-tracker.yml @@ -127,10 +127,11 @@ jobs: - [ ] Update status from ⏳ to ✅ (compatible) or ❌ (breaking) in COMPATIBILITY.md - [ ] Update the `Mail Template Changes` and `Breaking?` columns with accurate notes - ## Release (semantic versioning) - Once verified, releases mirror the Gitea version: - - [ ] Bump the **Template Release** column in `COMPATIBILITY.md` to **${{ steps.version.outputs.new_version }}** - - [ ] Tag the release with the same number: `git tag v${{ steps.version.outputs.new_version }} && git push origin v${{ steps.version.outputs.new_version }}` — the release workflow packages the archive automatically + ## Semantic tracking + Once verified, update the tracked Gitea version (release numbers stay unchanged): + - [ ] Update the parenthesized Gitea version on the active **Template Release** row in `COMPATIBILITY.md` (e.g. `v1.0.1(v${{ steps.version.outputs.new_version }})`) + - [ ] Update the README release line and badge to the new version + - [ ] Tag a new release only if the template content itself changed — `git tag vX.Y.Z && git push origin vX.Y.Z` (the release workflow packages automatically) labels: compatibility, automated env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/AGENTS.md b/AGENTS.md index 26b53cb..4d54866 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,7 +28,7 @@ tools/ # Go CLI tooling (modular, zero dependencies) preview/ # Browser-based live preview index.html # SPA with style/template/client/viewport switching rendered.js # Pre-rendered HTML (generated, committed for clone-and-preview) -docs/ # Bilingual documentation (English + Simplified Chinese only) +docs/ # Bilingual documentation (English + Simplified Chinese) ``` ## Working With Templates @@ -66,9 +66,10 @@ docs/ # Bilingual documentation (English + Simplified Chinese only ## Versioning -- Release versions **mirror the Gitea version they support**: Gitea `X.Y.Z` → template release `X.Y.Z` (git tag `vX.Y.Z`) -- The current release is **1.27.1** (tracks Gitea 1.27.1); the quick-reference table in `COMPATIBILITY.md` lists it first — the tracker workflow updates that row by position -- When a new Gitea version is verified compatible: bump the **Template Release** column in `COMPATIBILITY.md`, update the README release line and badge, then tag `vX.Y.Z` (the release workflow packages automatically on tag push) +- Release numbers stay on the project's own scheme; the supported Gitea version is appended in parentheses — `v1.0.1(v1.27.2)` means release `v1.0.1` tracks Gitea `1.27.2` +- The current release is **v1.0.1** (tracks Gitea 1.27.2); the quick-reference table in `COMPATIBILITY.md` lists it first — the tracker workflow updates that row by position +- When a new Gitea version is verified compatible: update the parenthesized Gitea version in the active `COMPATIBILITY.md` row, plus the README release line and badge +- 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 ## Commit Conventions diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index 14a5185..777ca24 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -7,23 +7,23 @@ This document tracks the compatibility between **Gitea Mail Templates** releases | Template Release | Min Gitea | Max Tested Gitea | Status | |-----------------|-----------|-----------------|--------| -| **1.27.1** | **1.25.0** | **1.27.1** | ✅ Active | -| **v1.0.1** | **1.25.0** | **1.27.1** | ✅ Superseded | +| **v1.0.1(v1.27.2)** | **1.25.0** | **1.27.2** | ✅ Active | | **v1.0.0** | **1.25.0** | **1.26.4** | ✅ Superseded | -> **Latest verified:** All 11 templates pass validation against Gitea 1.27.1 data contexts. +> **Latest verified:** All 11 templates pass validation against Gitea 1.27.2 data contexts. ## Versioning -From **1.27.1** onward, Gitea Mail Templates releases **mirror the Gitea version they support**: Gitea `X.Y.Z` uses template release `X.Y.Z` (tagged `vX.Y.Z`). +From **1.27.1** onward, template releases are **semantically tracked** against Gitea: the release keeps its own number, and the supported Gitea version is appended in parentheses — `v1.0.1(v1.27.2)` means release `v1.0.1` is the version to use with Gitea `1.27.2`. | Gitea version | Template release | |---------------|------------------| -| 1.27.1 | **1.27.1** | +| 1.27.2 | **v1.0.1(v1.27.2)** | +| 1.27.1 | **v1.0.1(v1.27.1)** | - The [tracker workflow](.github/workflows/gitea-tracker.yml) opens a PR when a new Gitea release appears, marking it ⏳ Pending Verification. -- After verification, bump the **Template Release** column to the new version and tag it with the same number — the [release workflow](.github/workflows/release.yml) packages the archive automatically on tag push. -- Releases before 1.27.1 used an independent numbering scheme (`v1.0.x`) and remain listed in the matrix for reference. +- After verification, update the parenthesized Gitea version on the active **Template Release** row. A new release (`vX.Y.Z`) is only tagged when the template content itself changes — the [release workflow](.github/workflows/release.yml) packages the archive automatically on tag push. +- Releases before Gitea 1.27.1 predate semantic tracking and keep their plain version numbers in the matrix. ## Check Your Gitea Version @@ -38,6 +38,7 @@ gitea --version | Gitea | Release Date | Mail Template Changes | Breaking? | |-------|-------------|----------------------|-----------| +| **1.27.2** | 2026-08-14 | None — security + bug fixes | No | | **1.27.1** | 2026-07-27 | Fixed push commit data paths: .ID → .UserCommit.GitCommit.ID (#38467) | No | | **1.27.0** | 2026-07-13 | None — no mail template changes | No | | **1.26.4** | 2026-06-21 | None — hotfix release | No | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfa4af1..ba7dc79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,8 +90,6 @@ Any readable commit message in semantic format is welcome. Such as: ## Translations -Only English and Simplified Chinese are maintained: - - English - [简体中文](docs/CONTRIBUTING.zh-CN.md) diff --git a/README.md b/README.md index b579163..db53b18 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ A curated collection of professionally designed, audience-driven email templates for self-hosted [Gitea](https://about.gitea.com) instances. -[![Gitea](https://img.shields.io/badge/Gitea-1.25+%20%7C%201.27.1%20tested-blue)](COMPATIBILITY.md) +[![Gitea](https://img.shields.io/badge/Gitea-1.25+%20%7C%201.27.2%20tested-blue)](COMPATIBILITY.md) -> **Release 1.27.1 — 110 template files, 10 visual styles, 11 email types each** +> **Release v1.0.1 — tracks Gitea 1.27.2 — 110 template files, 10 visual styles, 11 email types each** --- @@ -164,8 +164,8 @@ gitea-mail-templates/ ## Compatibility - **Gitea 1.25+** — matches the refactored mail template directory structure (v1.25) -- **Latest tested:** Gitea 1.27.1 -- **Versioning:** releases mirror the Gitea version they support — Gitea 1.27.1 → template release 1.27.1 (see [COMPATIBILITY.md](COMPATIBILITY.md)) +- **Latest tested:** Gitea 1.27.2 +- **Versioning:** releases are semantically tracked — Gitea 1.27.2 → template release v1.0.1(v1.27.2) (see [COMPATIBILITY.md](COMPATIBILITY.md)) - 100% variable-compatible with official Gitea templates — see [COMPATIBILITY.md](COMPATIBILITY.md) for the full matrix - 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 3bd35bd..997d3bd 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -79,8 +79,8 @@ cd tools && go run . dev ## 兼容性 - **Gitea 1.25+** — v1.25 引入的邮件模板目录结构 -- **最新测试：** Gitea 1.27.1 -- **版本号：** 发布版本与所支持的 Gitea 版本一致 — Gitea 1.27.1 → 模板发布版 1.27.1（详见 [COMPATIBILITY.md](COMPATIBILITY.md)） +- **最新测试：** Gitea 1.27.2 +- **版本号：** 发布版本语义化追踪 Gitea 版本 — Gitea 1.27.2 → 模板发布版 v1.0.1(v1.27.2)（详见 [COMPATIBILITY.md](COMPATIBILITY.md)） - 与 Gitea 官方模板 100% 兼容 — 详见 [COMPATIBILITY.md](COMPATIBILITY.md) ## 许可证