From cb9382ade476de71ee0b803ae1a9168347c9bb98 Mon Sep 17 00:00:00 2001 From: KenanZhu Date: Mon, 12 Oct 2026 10:18:29 +0800 Subject: [PATCH] docs: modify contribution guides --- CONTRIBUTING.md | 408 ++++++++++++++++++++++++++----------- docs/CONTRIBUTING.zh-CN.md | 400 +++++++++++++++++++++++++----------- 2 files changed, 567 insertions(+), 241 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 428d9a7..50352f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,13 @@ -# Contributing to Gitea Mail Templates +# Contributing +--- [简体中文](docs/CONTRIBUTING.zh-CN.md) -Contributions to themes, tooling, tests, documentation and translations are welcome. This guide covers the current source architecture; installation and release selection are described in the [README](README.md#installation). +Contributions to themes, tools, documentation and translations are welcome. This guide covers the development environment, command-line tools and contribution workflow. For template installation and release selection, see the [README](README.md#installation) and [compatibility matrix](COMPATIBILITY.md#compatibility-matrix). ## Local Development -Use **Go 1.24 or later**. From the repository root, prepare the dependencies and locked official inputs, then run the checks and generate the preview: +Use **Go 1.24 or later**. From the repository root, prepare the dependencies and locked official files, run the tests and generate the preview: ```bash cd tools @@ -16,35 +17,123 @@ go test ./... go run . preview all ``` -Open `preview/index.html` in a browser, or run `go run . dev` from `tools/` and visit [http://127.0.0.1:3456](http://127.0.0.1:3456) for live reload. The development server watches themes, the framework, the lock/cache and preview fixtures. +Then open [preview/index.html](preview/index.html) in a browser, or run `go run . dev` for live preview. The validation and packaging workflows use Python 3.11. -The CLI uses urfave/cli and the x/net HTML parser. Python 3.11 or later is used by the documentation and packaging checks. +The project is organized into a shared framework, theme styles and build tools. Official templates provide notification content, conditions, subjects and links. The shared framework handles presentation, while theme metadata and CSS select layouts and define styles. See the [README](README.md#project-directory-structure) for the directory layout. -### Common Commands +> [!NOTE] +> Downloaded official files, generated templates and preview data are not tracked in version control. Submit the relevant source files, tests and documentation; do not include `build/`, `dist/` or generated preview data. -Run these commands from `tools/`. Place flags before positional arguments. +## Development Tools -| Command | Result | +The CLI prepares official files, manages themes, builds templates and generates previews. + +> [!TIP] +> Run all commands below from `tools/`. Place options before positional arguments. In the examples, `my-theme` is a theme name; quote paths containing spaces. + +| Command | Purpose | |---|---| -| `go run . list` | List available themes | -| `go run . create my-theme` | Create theme metadata and CSS | -| `go run . build my-theme` | Generate one theme's installable templates | -| `go run . build all` | Generate every theme | -| `go run . preview all` | Build every theme and render all official languages | -| `go run . dev` | Start the development server on port 3456 | -| `go run . dev --port 3457` | Use a different local port | -| `go run . delete my-theme` | Remove the named theme's source directory | +| `upstream` | Prepare, synchronize or verify locked official build inputs | +| `build` | Generate installable themes from official inputs and shared controls | +| `list` | List available themes and their metadata | +| `create` | Create theme CSS and metadata for the shared framework | +| `delete` | Delete one or more theme source directories | +| `preview` | Pre-render mail templates to generate preview and test data | +| `dev` | Start a live-reload development server with SSE browser refresh | +| `help`, `h` | Show the command list or help for a specific command | -`build` writes to `build/themes//mail/` and records file and source hashes in `build.json`. `preview` also builds the templates, then writes `preview/rendered.js` and `preview/rendered/.js`. These generated files and the downloaded inputs are ignored by Git. Keep them out of contributions. +### upstream -## Adding a Theme +`upstream` manages the official files pinned by `gitea.lock.json`, including mail templates, locale files, the icon, license and reviewed adapter reference sources. Downloaded files are stored in `build/upstream/`. -1. Run `go run . create my-theme` from `tools/`. -2. Edit `themes/my-theme/theme.json` and `theme.css`. -3. Run `go test ./...` and `go run . preview all` from `tools/`. -4. Check desktop and mobile layouts in English, Simplified Chinese and at least one other official language. Include screenshots with the pull request. +| Subcommand | Behavior | +|---|---| +| `prepare` | Read the root lock file. Download and verify inputs if the cache is absent, or verify an existing cache before use. Does not modify the root lock file. | +| `sync --tag ` | Download the specified stable version's official files, verify them, then replace the cache and update the root lock file. | +| `verify` | Verify the existing cache against the root lock file, offline and read-only. | -Theme names start with a lowercase letter and may contain lowercase letters, digits and hyphens. A theme directory contains only `theme.json` and `theme.css`. +To prepare inputs for the first time or check them independently, run: + +```bash +go run . upstream prepare +go run . upstream verify +``` + +All three subcommands support `--root`, which defaults to `..` relative to the current working directory. For example: + +```powershell +go run . upstream verify --root "C:\Projects\GiteaMailTemplates" +``` + +The root lock file records the Gitea tag, its commit and file SHA-256 hashes. `verify` checks file hashes, reviewed adapter reference sources and English translation keys referenced by official templates. Missing keys in other languages produce warnings and fall back to English in the preview. Building and rendering also check framework translation keys and action-link anchors; cache verification does not replace those checks. + +#### Updating the Official Version + +Use `sync` only when reviewing a new official version. For example, to explicitly synchronize to `v28.0.0`: + +```bash +go run . upstream sync --tag v28.0.0 +go run . upstream verify +go test ./... +go run . preview all +``` + +Tags must use the `vX.Y.Z` format and identify a stable release of Gitea 28 or later. `latest`, prerelease tags and older version tags are not supported. `sync` resolves tags through `api.github.com` and downloads files from `raw.githubusercontent.com`; it does not accept a local Gitea clone or an authentication token option. + +After synchronization, review the lock file diff, adjust adapter logic and preview data as needed, and update compatibility records after validation. Synchronization does not automatically update documentation, release tags or compatibility conclusions. + +> [!IMPORTANT] +> When adapter reference sources change, review the affected behavior before updating their hashes. Do not change hashes simply to bypass the checks. + +Network or validation errors before cache replacement leave existing files unchanged. Cache replacement and root lock file writing are separate operations; if a filesystem error interrupts the process, check that both agree before retrying. Stop `dev` before updating inputs to avoid concurrent processes writing to the cache. + +### build + +`build` generates installable mail templates from locked official files, the shared framework and theme sources. Specify one or more themes, or use `all` to build every theme: + +```bash +go run . build aurora +go run . build aurora bloom +go run . build all +``` + +| Option | Default | Description | +|---|---|---| +| `--folder` | `../themes` | Theme source directory; its parent is used as the project root | + +When using another project path, that project's root must also provide the lock file and shared framework: + +```powershell +go run . build --folder "C:\Projects\GiteaMailTemplates\themes" aurora +``` + +Output is written to `build/themes//mail/`, with build provenance and generated file hashes recorded in the adjacent `build.json`. Rebuilding updates the selected themes and removes their obsolete templates; it does not clean unselected themes. Building does not deploy templates. See the [README](README.md#install-a-theme) for installation. + +> [!TIP] +> To change templates, edit theme sources, the shared framework or build adapter logic. Direct edits to generated `.tmpl` files are overwritten by subsequent builds and cause packaging provenance checks to fail. + +### list + +`list` displays theme names, modes and short descriptions, sorted by name: + +```bash +go run . list +``` + +Use `--folder` to select a theme directory; the default is `../themes`. The command validates theme metadata and styles without downloading official files or generating templates. Fix any reported theme-format errors first. + +### create + +`create` creates `theme.json` and `theme.css` for a new theme and supports creating multiple themes at once: + +```bash +go run . create my-theme +go run . create first-theme second-theme +``` + +Use `--folder` to select the theme source directory; the default is `../themes`. The command does not overwrite existing directories. Theme names start with a lowercase letter and contain only lowercase letters, digits and hyphens. Avoid `all`, because build and preview commands treat it as the selector for every theme. + +Edit the generated metadata and CSS to describe and style the theme. For example: ```json { @@ -55,76 +144,128 @@ Theme names start with a lowercase letter and may contain lowercase letters, dig } ``` -| Mode | Generated presentation | +`name` must match the directory name. Theme directories contain only these two source files, without copies of official mail templates or translations. + +| Mode | Presentation structure | |---|---| -| `framed` | Shared controls and a framework layout, styled with the theme's CSS. New themes use this mode with the `standard` layout. | -| `shared` | CSS in the official head partial and the official footer partial; no additional framework controls or per-mail overrides. | +| `framed` | Shared controls and a layout, styled with theme CSS. New themes default to this mode and the `standard` layout. | +| `shared` | CSS is added to the official head partial, and the official footer partial is retained. No framework controls or per-mail template overrides are added. | -### Shared Framework +A `framed` theme can use `layout` to select a preset from `framework/layouts/`. Headers, action buttons, fallback links, sidebars and footers live in `framework/mail/base/`. Structural changes shared by multiple themes belong in the framework; adaptation between official content and controls is handled in `tools/builder/framework.go`. -Headers, action buttons, fallback links, sidebars and footers live in `framework/mail/base/`. Layout presets live in `framework/layouts/`; the optional `layout` field selects a preset for framed themes. Colors, fonts and spacing belong in theme CSS. +Theme CSS uses existing classes such as `email-heading`, `email-text` and `email-subtext` to distinguish headings, body text and supporting text. Preserve official notification wording, translation keys, variables and functional links. Do not generate wording or hide notification content through CSS. The style validator rejects template expressions, external resource references and unsupported hiding rules. -`tools/builder/framework.go` adapts official action values and translation keys for the shared controls. Official templates retain responsibility for notification conditions, subjects, attachments and contextual links. Changes to controls or layout structure belong in the framework so all themes use the same adaptation logic. - -Layout fragments must form balanced presentation markup. `__HEADER__` inserts the shared header, `__MAIL_TYPE__` expands to the discovered mail ID, and `__SIDEBAR__` inserts the shared sidebar in footer fragments. Deployment logos use `{{AppUrl}}assets/img/favicon.png`; generated preview data embeds the downloaded icon for offline display. - -## Design Guidelines - -- Use email-compatible CSS. Theme CSS must not load external resources, generate text or hide official content. -- Use presentation markup for layout fragments. The validator accepts `table`, `tbody`, `tr`, `td`, `div` and `span` with supported presentation attributes. -- When editing an existing theme, preserve its visual identity: palette, typography, borders, header, buttons and layout. -- Check desktop and 390px mobile previews, including long text and URLs. Test Gmail, Outlook and Apple Mail where available; the browser preview does not emulate mail clients. -- Keep gallery images in PNG format, at most 50 KiB each; 10–20 KiB is preferred. Follow the [capture guide](docs/images/README.md) for consistent images. - -## Official Snapshot Updates - -`gitea.lock.json` records a stable Gitea 28+ tag, its commit and per-file SHA-256 hashes. Official mail templates, locale catalogs, the favicon, license and reviewed adapter references are downloaded into `build/upstream/`. Only the generated root lock is committed; official files are not maintained in the source tree. - -### Command Reference - -Run from `tools/`. Each upstream subcommand accepts `--root `, defaulting to `..` relative to the working directory. Place the flag after the subcommand and quote paths containing spaces: - -```powershell -go run . upstream verify --root "C:\Projects\GiteaMailTemplates" -``` - -| Command | Behavior | -|---|---| -| `go run . upstream prepare` | Read the root lock. Download and validate its exact inputs if the cache is absent; otherwise verify the existing cache offline. Leaves the root lock unchanged. | -| `go run . upstream verify` | Check the existing cache against the root lock, offline and read-only. Reports `[PASS]` and lists non-English missing keys as `[FALLBACK]`. | -| `go run . upstream sync --tag vX.Y.Z` | Resolve an explicit stable Gitea 28+ tag through the GitHub API, download and validate its files, then replace the cache and generate the root lock. | - -`sync` uses `api.github.com`; file downloads use `raw.githubusercontent.com`. These commands do not accept a local Gitea checkout, authentication tokens or an implicit `latest` version. Network errors and API rate limits stop the operation. Go may separately need network access to download its toolchain or modules. - -### Existing Clone and Offline Use - -`build`, `preview` and `dev` prepare inputs automatically. They require the committed root lock and validate cached files before use. Once the cache, Go toolchain and dependencies are available, builds can run offline. - -Use `upstream verify` to check the cache independently. It validates official file hashes, reviewed adapter references and official template keys in the English catalog. Build and rendering checks also cover framework translation keys and primary-action anchors, so cache verification is only one part of compatibility testing. - -### Missing Lock and Explicit Version Updates - -For an existing clone, restore the tracked `gitea.lock.json` if it is missing. The copy at `build/upstream/lock.json` cannot replace it. When intentionally initializing the lock, run: +After completing the theme, run the tests and generate a preview: ```bash -cd tools -go run . upstream sync --tag v28.0.0 -go run . upstream verify go test ./... +go run . preview my-theme +``` + +### delete + +`delete` removes the source directories of one or more named themes: + +```bash +go run . delete my-theme +go run . delete first-theme second-theme +``` + +Use `--folder` to select the theme directory; the default is `../themes`. + +> [!WARNING] +> After validation, the command deletes directories directly, without a confirmation prompt or recovery through the recycle bin. Check the names and preserve any changes you need before running it. + +Missing themes produce warnings; invalid themes and symlink directories are rejected. Themes are processed sequentially, so a later failure does not restore directories already deleted. `all` does not mean deleting every theme. + +Deleting sources does not remove previously generated builds, preview data or deployed templates. Run `preview all` again to update the preview manifest. Remove deployed templates separately at their actual installation location. + +### preview + +`preview` builds the selected themes and renders all locked official languages using sample data. Specify one or more themes, or use `all`: + +```bash +go run . preview aurora +go run . preview aurora bloom go run . preview all ``` -To review a different version, specify its tag explicitly. Review the lock diff, update the framework adapter and fixtures as needed, and complete the checks before updating compatibility records. `sync` changes the cache and lock only; documentation and release publication are separate steps. Use `prepare` for a missing cache. +| Option | Default | Description | +|---|---|---| +| `--folder` | `../themes` | Theme source directory; its parent is used as the project root | +| `--config` | `./data/templates_config.json` | Mail type descriptions and preview sample data | +| `--output` | `preview/rendered.js` under the project root | Preview manifest path | -Changes to the reviewed translation or mail-renderer sources require an adapter review before their reference hashes can be updated. Official English must contain all referenced keys; other languages use English fallback. New mail types require framework alignment and fixtures in `tools/data/templates_config.json`, which supplies preview metadata and example contexts. Keep integer values as integers in JSON fixtures for Go formatting. +Default output includes `preview/rendered.js` and `preview/rendered/.js`. Open [preview/index.html](preview/index.html) in a browser; no server is required. See the [README](README.md#controls-and-keyboard-shortcuts) for controls and shortcuts. -Network or validation failures before cache replacement leave existing inputs unchanged. Cache replacement and root-lock writing are separate operations; if a filesystem error interrupts them, inspect both before retrying. +> [!IMPORTANT] +> Each run overwrites the preview manifest at the output location instead of merging with previously selected themes. For example, after `preview aurora`, the manifest contains only Aurora. Run `preview all` to restore every theme. -### Cache Recovery +To use a custom output path: -`prepare` reports corrupt, incomplete or lock-mismatched caches without repairing them. `sync` also refuses to replace a non-empty invalid snapshot. Inspect the error and move the generated cache aside before preparing it again from the reviewed root lock. +```bash +go run . preview --config ./data/templates_config.json --output ../build/preview-review/rendered.js all +``` -For example, in PowerShell **from the repository root**, with an unused backup name: +> [!NOTE] +> Language data is written to a `rendered/` directory next to the output file. The command does not copy the preview interface or change its script references; the existing `preview/index.html` still reads data from the default location. + +When adding mail types or rendering branches, extend the descriptions and sample contexts in `tools/data/templates_config.json`. Keep integer values, such as counts and sizes, as integers in JSON. Use controlled test content for HTML fields such as body text, release notes and review content; do not include personal information or real credentials. + +> [!NOTE] +> The preview checks template structure and presentation using sample contexts. It does not replace parameter compatibility review for the target Gitea version. Browsers and mail clients also differ in their CSS support. + +### dev + +`dev` starts a local development server, building every theme and preparing preview data on startup: + +```bash +go run . dev +``` + +Open [http://127.0.0.1:3456](http://127.0.0.1:3456). The default port is `3456`; use `--port` to change it: + +```bash +go run . dev --port 3457 +``` + +The server listens only on `127.0.0.1`. Press `Ctrl + C` in the terminal to stop it. The command locates the project relative to the current `tools/` working directory and does not provide `--folder`, `--config` or `--root` options. + +The server watches theme sources, the shared framework, the root lock file, official cache and preview data in `tools/data/`. Changes trigger a rebuild and refresh the preview through server-sent events (SSE). If a build fails, resolve the terminal error and save the file again. + +> [!TIP] +> Refresh the page manually after editing `preview/index.html`. Stop and restart the server after editing Go tool code. These files are outside the current automatic rebuild watch scope. + +### help, h + +View all commands or help for a specific command: + +```bash +go run . help +go run . h +go run . help build +go run . preview --help +``` + +For `upstream` subcommand options, place `--help` after the subcommand: + +```bash +go run . upstream prepare --help +go run . upstream sync --help +go run . upstream verify --help +``` + +Tool diagnostics use the `[LEVEL] [NAME] Message` format. `[I]`, `[W]`, `[E]` and `[F]` mean information, warning, error and fatal error, respectively. Level markers use different colors in supported terminals; set `NO_COLOR` to disable colors. Failed commands return a nonzero exit code. Preserve the complete output when troubleshooting. + +## Frequently Asked Questions + +### What if the lock file or official cache is missing? + +If an existing clone lacks `gitea.lock.json`, restore the tracked root lock file. The copy at `build/upstream/lock.json` cannot replace it. If only the cache is missing, run `upstream prepare` rather than synchronizing to another version to recover it. `build`, `preview` and `dev` prepare official inputs automatically. They can run offline once the cache, Go toolchain and dependencies are available; `upstream verify` always checks local files only. For network errors or GitHub API rate limits during the initial download, resolve the network issue and retry. + +### What if the cache is corrupt or does not match the lock file? + +`prepare` does not repair corrupt caches automatically, and `sync` refuses to replace a non-empty invalid snapshot. Stop the development server, preserve the root lock file and move the cache to a backup location before preparing it again. For example, in PowerShell **from the repository root**, use a backup name that does not already exist: ```powershell Move-Item -LiteralPath .\build\upstream -Destination .\build\upstream.backup @@ -133,70 +274,91 @@ go run . upstream prepare go run . upstream verify ``` -Preserve the rest of `build/` and leave official cached files unedited. To return to a previous snapshot, restore its reviewed root lock and rebuild the cache in the same way. Stop `dev` before replacing inputs, and avoid concurrent processes writing to the same cache. +> [!WARNING] +> Do not edit official cached files directly or delete the rest of `build/`. To revert the official version, restore the previously reviewed root lock file and rebuild the cache in the same way. -### Known Upstream Formatting Issue +### Why does synchronizing a new version report changed adapter sources? -Gitea v28.0.0 contains a Polish `mail.team_invite.text_1` placeholder defect. Preview preserves the official output and reports `[UPSTREAM-WARN]`. The exception matches the exact reviewed source text; other formatting errors fail rendering. Report upstream defects without modifying the cached locale files. +The project pins reviewed mail-rendering and translation reference sources. When upstream changes these implementations, the tool requires another review to avoid using incompatible preview functions or variable structures. Examine the official changes, adjust adapter logic and relevant tests, then update the reference hashes. New mail types, translation keys, functions or variable paths may also require changes. Update [compatibility records](COMPATIBILITY.md) after validation; a successful download does not establish compatibility. -## Verification and Release +### Why do some languages use English or produce formatting warnings? -### Checks for a Pull Request +Official English must contain all referenced translation keys. Missing keys in other languages fall back to English and produce warnings. Preserve official locale files without adding translations to the cache. -From `tools/`, run `go test ./...` and `go run . preview all`. Tests cover deterministic generation, changes to action anchors, translation keys, and notification subjects, text and links across all themes and languages. Fixtures include push, review, reply, workflow and attachment branches. Shared controls and branding are accounted for separately from official notification content. +For example, Gitea v28.0.0 has a known placeholder defect in the Polish `mail.team_invite.text_1`. The preview preserves official output for the exact reviewed source text and reports a warning. This exception does not apply to other formatting errors. Include the version, translation key and reproduction details when reporting new issues for review and upstream feedback. -For documentation or packaging changes, run from the repository root: +### Why does the preview not show a new theme or recent changes? + +The static preview does not build automatically. Run `preview all` again and refresh the page, then confirm that the manifest contains the required themes. With a custom output path, check where the preview interface actually reads its data. With `dev`, first check the terminal for rebuild errors. Go code changes require a server restart; preview interface changes require a manual refresh. If the default port is occupied, select another port with `--port`. + +### Does a successful build mean all Gitea versions are supported? + +Builds target the official inputs specified in the root lock file. Other versions may change template directories, functions or variable structures, so a successful build or preview alone cannot establish backward compatibility. Select release archives using the [compatibility matrix](COMPATIBILITY.md#compatibility-matrix), rather than installing new-version templates directly on older instances. + +### Why does the packaging script reject the current output? + +Run `preview all` before packaging to ensure that every theme and language bundle is present and generated files match the current sources. The version argument must match the tag in the root lock file. Rebuild and regenerate previews after source or generated file changes. The script does not overwrite existing release archives. Use a new output directory when repackaging and retain old artifacts needed for comparison. + +## Other Contribution Information + +### Themes and the Shared Framework + +Use CSS suitable for mail clients. When editing an existing theme, preserve its palette, fonts, borders and layout, keep headings, body text and supporting text distinct, and account for long text, long URLs and mobile widths. Layout fragments use presentation markup and support `table`, `tbody`, `tr`, `td`, `div`, `span` and attributes allowed by the validator. Combined markup must have balanced tags. `__HEADER__` inserts the shared header, `__MAIL_TYPE__` expands to the mail ID, and `__SIDEBAR__` inserts the shared sidebar in footer fragments. Review changes to notification variables and conditions in the build adapter logic, not in theme CSS or layout presets. + +For new themes, update the galleries in both English and Chinese READMEs. Use PNG images of at most 50 KiB each; 10–20 KiB is preferred. Follow the [capture guide](docs/images/README.md) for consistent themes, mail types, languages and cropping. + +### Commits and Pull Requests + +Keep changes focused on a specific problem and avoid unrelated formatting changes. Describe the reason, scope and validation results in the pull request. For visual changes, you can include comparison images generated with sample data. When changing themes, the shared framework or Go tools, run from `tools/`: + +```bash +go test ./... +go run . preview all +``` + +For changes to mail content, links, variables or function adaptation, add regression tests covering affected conditional branches. Existing tests check generated output, translation keys, notification subjects, text and links across every theme and language, including push, review, reply, workflow and attachment branches. + +When changing packaging scripts, run from the repository root: ```bash python -B -m unittest discover -s .github/scripts -p 'test_*.py' ``` -Keep English and Simplified Chinese guides aligned when changing shared instructions. Include a description of the change, relevant checks and screenshots for visual changes in the pull request. +For documentation-only changes, check wording, command examples and links. Keep Chinese and English documentation aligned; preserve commands, paths, variables and version information without changing their meaning in translation. -### Preparing a Release - -Release tags must match the locked Gitea version. The current source refactor is unreleased; retain existing v28.0.0 and historical assets. - -1. Complete the Go tests, documentation checks and preview generation. -2. Update documentation and compatibility records with the verification results. Release notes are optional and are not used as the Release body. -3. Generate all themes and language bundles with `go run . preview all` from `tools/`. -4. Package the release and verify its contents before publication. - -For manual packaging, run from the repository root: - -```bash -python .github/scripts/package_release.py --version vX.Y.Z --output -``` - -Replace the version and output placeholder with the reviewed tag and a new directory. The script checks source and generated hashes, includes all language bundles, excludes stale theme builds, and refuses to overwrite existing archives. - -The release workflow uses the same script to package templates, previews, documentation, the upstream license and provenance. It publishes only the archives, with the tag as the Release title and an empty body. Version labels, badges and compatibility records are maintained manually; review archive documentation before tagging. Confirm Actions support and write permissions on the configured Gitea host before relying on automated publication. See [version maintenance](COMPATIBILITY.md#version-maintenance). - -### Gitea Workflow Configuration - -The release workflow uses the `linux-amd64-docker-small` runner label. The job image must support the Node.js actions used for checkout and toolchain setup, as well as Git and a POSIX shell. Go and Python are installed by the setup steps. - -Publication uses [`gitea-release-action@v1.3.7`](https://gitea.com/actions/gitea-release-action/src/tag/v1.3.7/action.yml) directly, with the instance URL, repository, built-in `GITEA_TOKEN`, tag, title and the two archive paths. The Release body is empty when created; no notes file or Issue reminder is required. The repository must allow release writes. Action URLs explicitly use `https://gitea.com` rather than depending on `DEFAULT_ACTIONS_URL`. - -Before publication, `actions/setup-node@v4` prepares Node.js 22. The current Gitea runner executes JavaScript actions with `node` from `PATH`; this provides the runtime interfaces used by the release action without `--experimental-fetch`. On repeated publication of an existing tag, the action preserves an existing body and replaces same-name attachments. It does not provide the previous script's draft-until-all-uploads-complete behavior. Review the release and attachments before retrying a failed publication. - -## Reporting Problems - -Include the Gitea version, template release or source commit, theme, mail type, language and steps to reproduce. For source-build problems, include the snapshot tag/commit and output from `go run . upstream verify` or `go run . preview all`. For display problems, include the mail client and a screenshot with personal data removed. - -## Commit Conventions +Use concise commit messages. The following prefixes are available as a reference: | Prefix | Scope | |---|---| -| `style():` | Theme presentation | -| `preview:` | Browser preview | +| `style():` | Theme presentation styles | +| `preview:` | Preview tools | | `tools:` | CLI, build and snapshot tools | | `docs:` | Documentation and translations | | `fix:` | Bug fixes | | `project:` | Repository configuration and project structure | | `refactor:` | Code restructuring | -| `chore:` | Maintenance | +| `chore:` | Routine maintenance | -## Translations and License +### Version and Release Maintenance -The [Simplified Chinese guide](docs/CONTRIBUTING.zh-CN.md) covers the same workflow. Contributions are licensed under MIT. Retain Gitea copyright and the upstream license when distributing derived templates; see [third-party notices](THIRD_PARTY_NOTICES.md). +Release tags must match the locked Gitea tag. Version labels, badges and compatibility records are maintained manually; changing official inputs does not trigger automatic version maintenance. Retain historical release assets and check documentation and compatibility records before tagging. After validation and generation of all previews, you can package manually from the repository root: + +```bash +python .github/scripts/package_release.py --version v28.0.0 --output build/release-review +``` + +Replace the example version with the tag in the root lock file and use an output directory without release archives of the same name. The script checks source and artifact hashes, packages themes, previews, documentation, the official license and provenance, and excludes stale theme builds. + +`.github/workflows/validate.yml` handles checks for ordinary pushes and pull requests and is also called by the Release workflow. After validation, Release packages the archives and uploads them through the release action. It uses the tag as the title and creates new releases with an empty body, without requiring a release notes file. Republishing an existing tag preserves its existing body and replaces same-name attachments. Check the release and attachment state before retrying a failed publication. + +Workflows use the `linux-amd64-docker-small` runner label, with setup steps preparing Go, Python and Node.js for publication. Actions use `actions/...@version` references, resolved through the runner's action source configuration; consider the current `github_mirror` setting when maintaining them. Publication uses the built-in `GITEA_TOKEN`, and the repository must permit release writes. + +### Reporting Problems + +Include the Gitea version, template release or source commit, theme, mail type, language and steps to reproduce. For build or preview issues, also include the tag in the root lock file, relevant commands and complete error output. For display issues, specify the mail client and attach screenshots with personal information removed. + +For improvement suggestions, explain the use case, expected result and affected themes or tools. For official template or translation defects, preserve the original inputs and provide a minimal example that reproduces the issue. + +### License + +This project uses the [MIT License](LICENSE). Contribute code, styles and images that can be legally redistributed. When generating or distributing derived templates, retain Gitea copyright, the official license and snapshot provenance; release archives already include these files. diff --git a/docs/CONTRIBUTING.zh-CN.md b/docs/CONTRIBUTING.zh-CN.md index 80f750a..c6f3f7a 100644 --- a/docs/CONTRIBUTING.zh-CN.md +++ b/docs/CONTRIBUTING.zh-CN.md @@ -1,10 +1,13 @@ # 贡献指南 +--- -欢迎改进主题、工具、测试、文档和翻译。本指南介绍当前源码架构的开发流程；安装和版本选择请参阅 [README](README.zh-CN.md#安装)。 +[English](../CONTRIBUTING.md) + +欢迎改进主题、工具、文档和翻译。本指南介绍开发环境、命令行工具和贡献流程。安装邮件模板和选择发行版本，请参阅 [README](README.zh-CN.md#安装)及[兼容性表](COMPATIBILITY.zh-CN.md#兼容性表)。 ## 本地开发 -使用 **Go 1.24 或更高版本**。从仓库根目录开始，准备依赖和锁定的官方文件，再运行检查并生成预览： +使用 **Go 1.24 或更高版本**。在仓库根目录执行以下命令，准备依赖和锁定的官方文件，运行测试并生成预览： ```bash cd tools @@ -14,35 +17,123 @@ go test ./... go run . preview all ``` -在浏览器中打开 `preview/index.html`，或在 `tools/` 中运行 `go run . dev`，访问 [http://127.0.0.1:3456](http://127.0.0.1:3456) 使用实时预览。开发服务器监听主题、框架、锁文件与缓存、预览测试数据的变化。 +随后在浏览器中打开 [preview/index.html](../preview/index.html)，或运行 `go run . dev` 使用实时预览。检查与打包工作流使用 Python 3.11。 -CLI 使用 urfave/cli 和 x/net HTML 解析器。文档与打包检查使用 Python 3.11 或更高版本。 +项目按共享框架、主题样式和构建工具组织。官方模板提供通知内容、条件、主题行和链接；共享框架负责邮件呈现，主题通过元数据和 CSS 选择布局、定义样式。目录说明见 [README](README.zh-CN.md#项目目录结构)。 -### 常用命令 +> [!NOTE] +> 下载的官方文件、生成的模板和预览数据不纳入版本控制。贡献时提交相应源码、测试和文档，无需提交 `build/`、`dist/` 或生成的预览数据。 -以下命令均在 `tools/` 中执行。带有位置参数时，将选项放在位置参数之前。 +## 开发工具 + +命令行工具提供官方文件准备、主题管理、模板构建和预览功能。 + +> [!TIP] +> 以下命令均在 `tools/` 中执行；带有位置参数时，将选项放在位置参数之前。示例中的 `my-theme` 表示主题名称，包含空格的路径需要加引号。 | 命令 | 用途 | |---|---| -| `go run . list` | 列出可用主题 | -| `go run . create my-theme` | 创建主题元数据和 CSS | -| `go run . build my-theme` | 生成指定主题的安装模板 | -| `go run . build all` | 生成全部主题 | -| `go run . preview all` | 构建全部主题并渲染所有官方语言 | -| `go run . dev` | 在端口 3456 启动开发服务器 | -| `go run . dev --port 3457` | 指定其他本地端口 | -| `go run . delete my-theme` | 删除指定主题的源码目录 | +| `upstream` | 准备、同步或校验锁定的官方构建输入 | +| `build` | 根据官方输入和共享控件生成可安装的主题 | +| `list` | 列出可用主题及其元数据 | +| `create` | 创建使用共享框架的主题 CSS 和元数据 | +| `delete` | 删除一个或多个主题源码目录 | +| `preview` | 预渲染邮件模板，生成预览和测试数据 | +| `dev` | 启动通过 SSE 刷新页面的热重载开发服务器 | +| `help`、`h` | 显示命令列表或指定命令的帮助 | -`build` 将模板写入 `build/themes/<名称>/mail/`，并在 `build.json` 中记录文件和源码哈希。`preview` 同时完成构建，随后写入 `preview/rendered.js` 和 `preview/rendered/<语言>.js`。这些生成文件和下载的官方文件均被 Git 忽略，无需随贡献提交。 +### upstream -## 添加主题 +`upstream` 管理 `gitea.lock.json` 锁定的官方文件，包括邮件模板、语言文件、图标、许可证和已评审的适配参考源码。下载的文件保存到 `build/upstream/`。 -1. 在 `tools/` 中运行 `go run . create my-theme`。 -2. 编辑 `themes/my-theme/theme.json` 和 `theme.css`。 -3. 在 `tools/` 中运行 `go test ./...` 和 `go run . preview all`。 -4. 检查英文、简体中文及至少另一种官方语言的桌面与移动端布局，在拉取请求中附上截图。 +| 子命令 | 行为 | +|---|---| +| `prepare` | 读取根锁文件。缓存缺失时下载并校验；已有缓存则校验后使用。不修改根锁文件。 | +| `sync --tag ` | 下载指定稳定版本的官方文件，校验后替换缓存并更新根锁文件。 | +| `verify` | 对照根锁文件，只读、离线校验已有缓存。 | -主题名称以小写字母开头，可包含小写字母、数字和连字符。主题目录只包含 `theme.json` 和 `theme.css`。 +首次准备或单独检查输入时执行： + +```bash +go run . upstream prepare +go run . upstream verify +``` + +三个子命令均支持 `--root`，默认值为相对当前工作目录的 `..`。例如： + +```powershell +go run . upstream verify --root "C:\Projects\GiteaMailTemplates" +``` + +根锁文件记录 Gitea 标签、对应提交和文件的 SHA-256。`verify` 检查文件哈希、已评审的适配参考源码，以及官方模板引用的英文翻译键；非英文语言缺少的键会报告警告，并在预览中回退为英文。构建和渲染还会检查框架使用的翻译键及操作链接锚点，缓存校验不能代替这些检查。 + +#### 更新官方版本 + +只有需要评审新的官方版本时才使用 `sync`。例如，明确同步到 `v28.0.0`： + +```bash +go run . upstream sync --tag v28.0.0 +go run . upstream verify +go test ./... +go run . preview all +``` + +标签必须采用 `vX.Y.Z` 格式，并且是 Gitea 28 或更高版本的稳定标签；不支持 `latest`、预发布标签或旧版本标签。`sync` 通过 `api.github.com` 解析标签，通过 `raw.githubusercontent.com` 下载文件，不接受本地 Gitea 克隆或认证令牌参数。 + +同步后检查锁文件差异，按需调整适配逻辑和预览数据，完成验证后更新兼容性记录。同步不会自动更新文档、发行标签或兼容性结论。 + +> [!IMPORTANT] +> 适配参考源码发生变化时，须先评审相关行为，再更新对应参考哈希，不应仅修改哈希以跳过检查。 + +网络或校验错误发生在缓存替换前时，原有文件保持不变。缓存替换和根锁文件写入是两个操作；文件系统错误中断操作后，重试前应检查二者是否一致。更新输入前先停止 `dev`，避免多个进程同时写入缓存。 + +### build + +`build` 根据锁定的官方文件、共享框架和主题源码生成可安装的邮件模板。必须指定一个或多个主题，或使用 `all` 构建全部主题： + +```bash +go run . build aurora +go run . build aurora bloom +go run . build all +``` + +| 选项 | 默认值 | 说明 | +|---|---|---| +| `--folder` | `../themes` | 主题源码目录；工具将其父目录作为项目根目录 | + +使用其他项目路径时，该项目根目录也需要提供锁文件和共享框架： + +```powershell +go run . build --folder "C:\Projects\GiteaMailTemplates\themes" aurora +``` + +结果写入 `build/themes/<名称>/mail/`，同级的 `build.json` 记录构建来源和生成文件的校验值。重新构建会更新所选主题的模板并清理其过时模板，不清理未选中的主题。构建不会部署邮件模板，安装步骤见 [README](README.zh-CN.md#安装主题)。 + +> [!TIP] +> 需要修改模板时，应编辑主题源码、共享框架或构建适配逻辑。直接修改生成的 `.tmpl` 文件会在后续构建中被覆盖，也会导致打包时的来源校验失败。 + +### list + +`list` 按名称排序，显示主题名称、模式和简短说明： + +```bash +go run . list +``` + +可通过 `--folder` 指定主题目录，默认值为 `../themes`。命令会校验主题元数据和样式，不下载官方文件，也不生成模板。主题格式无效时，应先修复报告的问题。 + +### create + +`create` 为新主题创建 `theme.json` 和 `theme.css`，支持一次创建多个主题： + +```bash +go run . create my-theme +go run . create first-theme second-theme +``` + +可通过 `--folder` 指定主题源码目录，默认值为 `../themes`。命令不会覆盖已存在的目录。主题名称以小写字母开头，仅包含小写字母、数字和连字符；避免使用 `all`，因为构建和预览命令将其作为全部主题的选择参数。 + +编辑生成的元数据和 CSS，定义主题说明及样式。例如： ```json { @@ -53,76 +144,128 @@ CLI 使用 urfave/cli 和 x/net HTML 解析器。文档与打包检查使用 Pyt } ``` -| 模式 | 生成的展示结构 | +`name` 必须与目录名称一致。主题目录仅保存这两个源码文件，不保存官方邮件模板或翻译副本。 + +| 模式 | 展示结构 | |---|---| -| `framed` | 使用共享控件和框架布局，由主题 CSS 定义样式。新主题默认使用此模式及 `standard` 布局。 | +| `framed` | 使用共享控件和布局，由主题 CSS 定义样式。新主题默认使用此模式及 `standard` 布局。 | | `shared` | 在官方页头片段中加入 CSS，并保留官方页脚片段；不增加框架控件或各类邮件的覆盖模板。 | -### 共享框架 +`framed` 主题可通过 `layout` 选择 `framework/layouts/` 中的布局预设。页头、操作按钮、备用链接、侧栏和页脚位于 `framework/mail/base/`。多个主题共用的结构调整应放在共享框架中，官方内容与控件之间的适配位于 `tools/builder/framework.go`。 -页头、操作按钮、备用链接、侧栏和页脚位于 `framework/mail/base/`。布局预设位于 `framework/layouts/`，`framed` 主题可通过可选的 `layout` 字段选择预设。配色、字体和间距由主题 CSS 定义。 +主题 CSS 使用 `email-heading`、`email-text`、`email-subtext` 等现有类定义标题、正文和辅助说明层级。保留官方通知文字、翻译键、变量和功能链接，不通过 CSS 生成文案或隐藏业务内容。样式校验器会拒绝模板表达式、外部资源引用和不受支持的隐藏规则。 -`tools/builder/framework.go` 将官方操作值和翻译键适配到共享控件。通知条件、主题行、附件和上下文链接由官方模板定义。控件或布局结构的修改应放在框架中，使各主题使用同一套适配逻辑。 - -布局片段组合后必须形成标签配对完整的展示结构。`__HEADER__` 插入共享页头，`__MAIL_TYPE__` 展开为发现的邮件 ID，页脚片段中的 `__SIDEBAR__` 插入共享侧栏。部署模板的 Logo 使用 `{{AppUrl}}assets/img/favicon.png`；生成的预览数据嵌入下载的图标，供离线显示。 - -## 设计规范 - -- 使用兼容邮件客户端的 CSS。主题 CSS 不得加载外部资源、生成文字或隐藏官方内容。 -- 布局片段使用展示性标记。校验器接受 `table`、`tbody`、`tr`、`td`、`div`、`span` 及支持的展示属性。 -- 修改已有主题时，保留其配色、字体、边框、页头、按钮和布局特征。 -- 检查桌面和 390px 移动端预览，覆盖长文本和长 URL。条件允许时测试 Gmail、Outlook 和 Apple Mail；浏览器预览不能模拟邮件客户端。 -- 画廊图片使用 PNG，单张不超过 50 KiB，建议为 10–20 KiB。按[截图指南](images/README.md)保持截图一致。 - -## 更新官方快照 - -`gitea.lock.json` 记录稳定的 Gitea 28+ 标签、对应提交和每个文件的 SHA-256。官方邮件模板、语言文件、图标、许可证和已评审的适配参考源码下载到 `build/upstream/`。仓库仅提交生成的根锁文件，不维护官方文件副本。 - -### 命令参考 - -在 `tools/` 中执行。每个上游子命令均支持 `--root <仓库根目录>`，默认值为相对当前工作目录的 `..`。参数放在子命令之后，包含空格的路径需要加引号： - -```powershell -go run . upstream verify --root "C:\Projects\GiteaMailTemplates" -``` - -| 命令 | 行为 | -|---|---| -| `go run . upstream prepare` | 读取根锁文件。缓存不存在时下载并校验对应文件；已有缓存则离线校验。不修改根锁文件。 | -| `go run . upstream verify` | 对照根锁文件离线、只读检查已有缓存。输出 `[PASS]`，并以 `[FALLBACK]` 列出非英文语言缺少的键。 | -| `go run . upstream sync --tag vX.Y.Z` | 通过 GitHub API 解析明确指定的稳定 Gitea 28+ 标签，下载并校验文件，然后替换缓存并生成根锁文件。 | - -`sync` 使用 `api.github.com`，文件下载使用 `raw.githubusercontent.com`。这些命令不接受本地 Gitea 克隆、认证令牌或隐式的 `latest` 版本。网络错误和 API 限流会中止操作；Go 工具链或模块可能仍需单独联网下载。 - -### 已有克隆与离线使用 - -`build`、`preview` 和 `dev` 会自动准备输入，需要已提交的根锁文件，并在使用缓存前完成校验。缓存、Go 工具链和依赖齐备后，可以离线构建。 - -需要单独检查缓存时，使用 `upstream verify`。它校验官方文件哈希、已评审的适配参考源码，以及官方模板引用的英文翻译键。构建和渲染还会检查框架翻译键及主要操作链接的锚点，因此缓存校验只是兼容性测试的一部分。 - -### 锁文件缺失与显式更新版本 - -已有克隆缺少 `gitea.lock.json` 时，应恢复受版本控制的文件。`build/upstream/lock.json` 中的副本不能替代根锁文件。需要有意初始化锁文件时，执行： +完成主题后运行测试并生成预览： ```bash -cd tools -go run . upstream sync --tag v28.0.0 -go run . upstream verify go test ./... +go run . preview my-theme +``` + +### delete + +`delete` 删除指定主题的源码目录，支持一个或多个名称： + +```bash +go run . delete my-theme +go run . delete first-theme second-theme +``` + +可通过 `--folder` 指定主题目录，默认值为 `../themes`。 + +> [!WARNING] +> 命令校验主题后直接删除目录，不提供确认提示或回收站恢复。执行前确认名称，并保留需要的修改。 + +不存在的主题会报告警告；无效主题或符号链接目录会被拒绝。多个主题依次处理，后续失败不会恢复已删除的目录。`all` 不表示删除全部主题。 + +删除源码不会移除之前生成的构建文件、预览数据或已部署的模板。重新执行 `preview all` 更新预览清单；需要移除部署的主题时，按实际安装路径单独处理。 + +### preview + +`preview` 构建所选主题，并使用示例数据渲染全部锁定的官方语言。必须指定一个或多个主题，或使用 `all`： + +```bash +go run . preview aurora +go run . preview aurora bloom go run . preview all ``` -评审其他版本时，明确指定对应标签。检查锁文件差异，按需更新框架适配逻辑和测试数据，完成检查后，再更新兼容性记录。`sync` 只修改缓存和锁文件，文档更新与版本发布需单独完成。仅缺少缓存时使用 `prepare`。 +| 选项 | 默认值 | 说明 | +|---|---|---| +| `--folder` | `../themes` | 主题源码目录；其父目录作为项目根目录 | +| `--config` | `./data/templates_config.json` | 邮件类型说明和预览示例数据 | +| `--output` | 项目根目录下的 `preview/rendered.js` | 预览清单路径 | -已评审的翻译或邮件渲染参考源码发生变化时，须先评审适配逻辑，再更新参考哈希。官方英文必须包含所有引用的翻译键；其他语言缺少的翻译回退为英文。新增邮件类型需要补充框架适配和 `tools/data/templates_config.json` 中的测试数据，该文件提供预览元数据和示例上下文。JSON 测试数据中的整数应保持整数形式，以便 Go 正确格式化。 +默认输出包括 `preview/rendered.js` 和 `preview/rendered/<语言>.js`。在浏览器中打开 [preview/index.html](../preview/index.html) 即可查看，无需启动服务器。操作和快捷键见 [README](README.zh-CN.md#控制和快捷键)。 -缓存替换前发生网络或校验错误时，原有文件保持不变。缓存替换和根锁文件写入是两个操作；文件系统错误中断操作后，重试前应检查二者是否一致。 +> [!IMPORTANT] +> 每次生成会覆盖输出位置的预览清单，不与先前选择的主题合并。例如，执行 `preview aurora` 后，该清单只包含 Aurora；需要恢复全部主题时执行 `preview all`。 -### 缓存恢复 +自定义输出示例： -`prepare` 会报告损坏、不完整或与锁文件不匹配的缓存，不会自动修复。`sync` 同样拒绝替换非空的无效快照。检查错误后，将生成的缓存移至备份位置，再按已评审的根锁文件重新准备。 +```bash +go run . preview --config ./data/templates_config.json --output ../build/preview-review/rendered.js all +``` -例如，在**仓库根目录的 PowerShell** 中，使用尚不存在的备份名称： +> [!NOTE] +> 语言数据写入输出文件同级的 `rendered/` 目录。命令不会复制预览界面或修改其脚本引用；现有 `preview/index.html` 仍读取默认位置的数据。 + +新增邮件类型或渲染分支时，补充 `tools/data/templates_config.json` 中的说明和示例上下文。JSON 中用于计数、大小等数值的整数应保持整数形式。正文、发布说明和评审内容等 HTML 字段应使用可控的测试内容，避免包含个人信息或真实凭据。 + +> [!NOTE] +> 预览用于检查模板结构和展示效果。它使用示例上下文，不能代替目标 Gitea 版本的参数兼容性评审；浏览器与邮件客户端对 CSS 的支持也存在差异。 + +### dev + +`dev` 启动本地开发服务器，首次启动时构建全部主题并准备预览数据： + +```bash +go run . dev +``` + +打开 [http://127.0.0.1:3456](http://127.0.0.1:3456)。默认端口为 `3456`，可通过 `--port` 修改： + +```bash +go run . dev --port 3457 +``` + +服务器仅监听 `127.0.0.1`。在终端中按 `Ctrl + C` 停止运行。该命令按当前 `tools/` 工作目录定位项目，不提供 `--folder`、`--config` 或 `--root` 选项。 + +服务器监听主题源码、共享框架、根锁文件、官方缓存及 `tools/data/` 中的预览数据。文件变化后重新构建，通过服务器发送事件（SSE）刷新预览。构建失败时，根据终端输出修复问题，再保存文件。 + +> [!TIP] +> 修改 `preview/index.html` 后手动刷新页面；修改 Go 工具代码后停止并重新启动服务器。这些文件不属于当前的自动重建监听范围。 + +### help、h + +查看全部命令或指定命令的帮助： + +```bash +go run . help +go run . h +go run . help build +go run . preview --help +``` + +查看 `upstream` 子命令的参数时，将 `--help` 放在子命令后： + +```bash +go run . upstream prepare --help +go run . upstream sync --help +go run . upstream verify --help +``` + +工具诊断信息采用 `[LEVEL] [NAME] Message` 格式，`[I]`、`[W]`、`[E]`、`[F]` 分别表示信息、警告、错误和致命错误。在支持颜色的终端中，等级标记使用不同颜色；设置 `NO_COLOR` 可禁用颜色。命令失败时返回非零退出码，排查时保留完整输出。 + +## 常见问题 + +### 缺少锁文件或官方缓存怎么办？ + +已有克隆缺少 `gitea.lock.json` 时，应恢复受版本控制的根锁文件。缓存中的 `build/upstream/lock.json` 不能代替它。仅缺少缓存时执行 `upstream prepare`，不要为了恢复缓存而同步到其他版本。`build`、`preview` 和 `dev` 会自动准备官方输入。缓存、Go 工具链和依赖齐备后可以离线使用；`upstream verify` 始终只检查本地文件。首次下载遇到网络错误或 GitHub API 限流时，解决网络问题后重试。 + +### 缓存损坏或与锁文件不匹配怎么办？ + +`prepare` 不会自动修复损坏的缓存，`sync` 也会拒绝替换非空的无效快照。先停止开发服务器，保留根锁文件，将缓存移至备份位置后重新准备。例如，在**仓库根目录的 PowerShell** 中，使用尚不存在的备份名称： ```powershell Move-Item -LiteralPath .\build\upstream -Destination .\build\upstream.backup @@ -131,63 +274,64 @@ go run . upstream prepare go run . upstream verify ``` -保留 `build/` 中的其他内容，不直接编辑缓存中的官方文件。需要回退快照时，恢复此前已评审的根锁文件，再按同样方式重建缓存。替换输入前先停止 `dev`，避免多个进程同时写入同一缓存。 +> [!WARNING] +> 不要直接修改缓存中的官方文件，也不要删除 `build/` 中的其他内容。回退官方版本时，恢复此前已评审的根锁文件，再按同样方式重建缓存。 -### 已知上游格式问题 +### 为什么同步新版本时提示适配源码发生变化？ -Gitea v28.0.0 的波兰语 `mail.team_invite.text_1` 存在占位符缺陷。预览保留官方输出并报告 `[UPSTREAM-WARN]`。该例外仅匹配已评审的完整原文，其他格式错误会使渲染失败。发现上游问题时应报告问题，不修改缓存中的语言文件。 +项目固定了已评审的邮件渲染和翻译参考源码。上游修改这些实现后，工具会要求重新评审，避免继续使用不匹配的预览函数或变量结构。检查官方改动，调整适配逻辑和相关测试，再更新参考哈希。新增邮件、翻译键、函数或变量路径都可能需要对应修改。验证通过后再更新[兼容性记录](COMPATIBILITY.zh-CN.md)，不要把成功下载等同于完成兼容性确认。 -## 验证与发布 +### 为什么部分语言使用英文或出现格式警告？ -### 拉取请求检查 +官方英文必须包含所有引用的翻译键；其他语言缺少的键回退为英文，并报告警告。保留官方语言文件，不在缓存中补写译文。 -在 `tools/` 中运行 `go test ./...` 和 `go run . preview all`。测试覆盖生成结果的确定性、操作锚点变化、翻译键，以及全部主题和语言的通知主题行、正文与链接。测试数据包含推送、评审、回复、工作流和附件分支；共享控件与品牌展示作为附加内容单独处理。 +例如 Gitea v28.0.0 的波兰语 `mail.team_invite.text_1` 存在已知占位符缺陷。预览对已评审的完整原文保留官方输出并报告警告，该例外不适用于其他格式错误。新增问题应提供版本、翻译键和复现信息，以便评审和向上游反馈。 -修改文档或打包流程时，在仓库根目录执行： +### 为什么预览没有显示新主题或最新修改？ + +静态预览不会自动构建。重新执行 `preview all` 并刷新页面，确认预览清单包含所需主题。使用自定义输出路径时，检查预览界面实际读取的位置；使用 `dev` 时，先查看终端是否报告重建失败。Go 代码变更需要重启服务器，预览界面变更需要手动刷新。默认端口被占用时，使用 `--port` 指定其他端口。 + +### 构建成功是否意味着支持所有 Gitea 版本？ + +构建结果针对根锁文件指定的官方输入。不同版本可能修改模板目录、函数或变量结构，不能仅凭构建或预览成功确认向下兼容。部署时按[兼容性表](COMPATIBILITY.zh-CN.md#兼容性表)选择发行包，不将新版本模板直接用于旧版本实例。 + +### 为什么打包脚本拒绝当前产物？ + +打包前执行 `preview all`，确保全部主题和语言数据齐备，且生成文件与当前源码一致。版本参数必须与根锁文件中的标签一致。源码或生成文件变化后，应重新构建和预览。脚本不会覆盖已有发行压缩包。重新打包时选择新的输出目录，保留需要对照的旧产物。 + +## 其它事宜 + +### 主题与共享框架 + +使用适合邮件客户端的 CSS。修改已有主题时，保留其配色、字体、边框和布局特征，使标题、正文和辅助说明的层级清晰，并考虑长文本、长 URL 和移动端宽度。布局片段使用展示性标记，支持 `table`、`tbody`、`tr`、`td`、`div`、`span` 及校验器允许的属性。组合后的标签必须完整配对；`__HEADER__` 插入共享页头，`__MAIL_TYPE__` 展开为邮件 ID，页脚中的 `__SIDEBAR__` 插入共享侧栏。业务变量和通知条件的变更应在构建适配逻辑中评审，不放入主题 CSS 或布局预设。 + +新增主题时更新中英文 README 的画廊。图片使用 PNG，单张不超过 50 KiB，建议为 10–20 KiB；主题、模板、语言和裁切方式按[截图指南](images/README.md)保持一致。 + +### 提交与拉取请求 + +围绕一个明确问题组织改动，避免混入无关的格式调整。拉取请求说明修改原因、影响范围和验证结果；涉及视觉变化时，可附上使用示例数据生成的对照图。修改主题、共享框架或 Go 工具时，在 `tools/` 中运行： + +```bash +go test ./... +go run . preview all +``` + +涉及邮件内容、链接、变量或函数适配时，补充对应的回归测试，覆盖受影响的条件分支。现有测试检查生成结果、翻译键及全部主题和语言的通知主题行、正文与链接，包括推送、评审、回复、工作流和附件分支。 + +修改打包脚本时，在仓库根目录运行： ```bash python -B -m unittest discover -s .github/scripts -p 'test_*.py' ``` -调整通用说明时，同步更新英文和简体中文指南。拉取请求应说明改动内容及相关检查结果，涉及视觉变化时附上截图。 +纯文档修改检查文字、命令示例和链接即可。中文文档与英文文档应保持内容一致；翻译时保留命令、路径、变量和版本信息，不改变原意。 -### 准备发行版 - -发行标签必须与锁定的 Gitea 版本一致。当前源码重构尚未发布，已有 v28.0.0 和历史版本的附件应保留。 - -1. 完成 Go 测试、文档检查和预览生成。 -2. 按验证结果更新文档和兼容性记录。发行说明为可选内容，不用于 Release 正文。 -3. 在 `tools/` 中运行 `go run . preview all`，生成全部主题和语言数据。 -4. 打包并检查发行包内容后再发布。 - -手动打包时，在仓库根目录执行： - -```bash -python .github/scripts/package_release.py --version vX.Y.Z --output -``` - -将版本和输出目录占位符替换为已评审的标签及新的目录。脚本会检查源码与产物哈希，包含所有语言数据包，排除残留的旧主题构建，并拒绝覆盖已有压缩包。 - -发布工作流使用同一脚本打包模板、预览、文档、官方许可证和来源信息，仅上传发行归档，以标签作为 Release 标题，新建 Release 的正文为空。版本标记、徽章和兼容性记录均由维护者手动修改，归档文档应在打标签前检查。依赖自动发布前，请确认所用 Gitea 主机的 Actions 支持和写入权限。工作流行为见[版本维护](COMPATIBILITY.zh-CN.md#版本维护)。 - -### Gitea 工作流配置 - -发布工作流使用 `linux-amd64-docker-small` Runner 标签。任务镜像需要支持检出和工具链安装步骤使用的 Node.js Action，并提供 Git 和 POSIX Shell。Go 与 Python 由安装步骤准备。 - -发布直接使用 [`gitea-release-action@v1.3.7`](https://gitea.com/actions/gitea-release-action/src/tag/v1.3.7/action.yml)，传入实例地址、仓库、内置 `GITEA_TOKEN`、标签、标题和两个归档路径。新建 Release 的正文为空，不要求发行说明文件，也不创建提醒 Issue。仓库需允许发行版写入。Action 地址显式使用 `https://gitea.com`，不依赖 `DEFAULT_ACTIONS_URL` 配置。 - -发布前通过 `actions/setup-node@v4` 准备 Node.js 22。当前 Gitea runner 使用 `PATH` 中的 `node` 执行 JavaScript Action，提供发布 Action 所需的运行接口，无需 `--experimental-fetch`。重复发布已有标签时，Action 保留已有正文并替换同名附件，不具备原脚本在全部附件上传完成前保持草稿的行为。发布失败后，重试前应检查发行版和附件。 - -## 报告问题 - -请提供 Gitea 版本、模板发行版或源码提交、主题、邮件类型、语言和复现步骤。源码构建问题还应包含快照标签与提交，以及 `go run . upstream verify` 或 `go run . preview all` 的输出。显示问题请注明邮件客户端，并附上移除个人信息后的截图。 - -## 提交规范 +提交信息使用简短说明，可参考以下前缀： | 前缀 | 范围 | |---|---| | `style(<名称>):` | 主题展示样式 | -| `preview:` | 浏览器预览 | +| `preview:` | 预览工具 | | `tools:` | CLI、构建与快照工具 | | `docs:` | 文档和翻译 | | `fix:` | 问题修复 | @@ -195,6 +339,26 @@ python .github/scripts/package_release.py --version vX.Y.Z --output