docs(readme): readme.txt als Changelog-SSOT beschreiben
This commit is contained in:
@@ -8,7 +8,7 @@ Dieses Repo ist die Heimat für **geteilte CI-Bausteine**, die von anderen IDF-R
|
|||||||
|
|
||||||
Aktuell enthalten:
|
Aktuell enthalten:
|
||||||
|
|
||||||
- `.gitea/workflows/release-plugin.yml` — Reusable Workflow für WordPress-Plugin-Releases. Bei Tag-Push (`v*.*.*`) prüft er Version-Konsistenz, extrahiert den Changelog-Block, baut das ZIP und legt einen Gitea-Release mit ZIP-Asset an.
|
- `.gitea/workflows/release-plugin.yml` — Reusable Workflow für WordPress-Plugin-Releases. Bei Tag-Push (`v*.*.*`) prüft er Versions-Konsistenz über alle vier Sync-Stellen, extrahiert den Changelog-Block aus `readme.txt`, baut das ZIP und legt einen Gitea-Release mit ZIP-Asset an.
|
||||||
|
|
||||||
Geplant:
|
Geplant:
|
||||||
|
|
||||||
@@ -35,7 +35,37 @@ jobs:
|
|||||||
secrets: inherit
|
secrets: inherit
|
||||||
```
|
```
|
||||||
|
|
||||||
Für die Anwendung reicht `git tag v1.2.3 && git push --tags`. Alles andere macht der Reusable Workflow.
|
Für die Anwendung reicht `git tag v1.2.3 && git push --tags`. Alles andere macht der Reusable Workflow. Details und Fehlerdiagnose im [Caller-Template](docs/plugin-caller-template.md).
|
||||||
|
|
||||||
|
## Pflichtdateien im Plugin-Repo
|
||||||
|
|
||||||
|
Damit der Reusable Workflow durchläuft, müssen im Plugin-Repo vorhanden sein:
|
||||||
|
|
||||||
|
1. **`<slug>.php`** — Plugin-Haupt-PHP mit WordPress-Plugin-Header inklusive Zeile `Version: X.Y.Z`.
|
||||||
|
2. **Versions-Konstante** in einer beliebigen PHP-Datei:
|
||||||
|
`define('IDF_<UPPER_SLUG_OHNE_IDF_>_VERSION', 'X.Y.Z');`
|
||||||
|
Beispiel: `idf-login-branding` → `IDF_LOGIN_BRANDING_VERSION`.
|
||||||
|
3. **`readme.txt`** im Repo-Root im WordPress-Plugin-Format mit mindestens:
|
||||||
|
```
|
||||||
|
=== Plugin Name ===
|
||||||
|
Requires at least: 6.0
|
||||||
|
Tested up to: 6.4
|
||||||
|
Requires PHP: 7.4
|
||||||
|
Stable tag: 1.2.3
|
||||||
|
|
||||||
|
== Description ==
|
||||||
|
…
|
||||||
|
|
||||||
|
== Changelog ==
|
||||||
|
|
||||||
|
= 1.2.3 =
|
||||||
|
* Neu: Feature xyz
|
||||||
|
* Fix: Bug abc
|
||||||
|
```
|
||||||
|
|
||||||
|
Alle vier Versionen (Tag, Plugin-Header, PHP-Konstante, `Stable tag:`) müssen identisch sein. Der Pre-Flight-Check im Reusable bricht sonst ab.
|
||||||
|
|
||||||
|
`readme.txt` ist die **einzige Pflege-Stelle für den Changelog**. Master-Key parst sie später auch für den automatischen Sync der öffentlichen Plugin-CPT-Seite auf `ihre-ideenfabrik.de`. `CHANGELOG.md` wird nicht mehr gepflegt und fliegt im ZIP-Bau raus.
|
||||||
|
|
||||||
## Versionierung dieses Repos
|
## Versionierung dieses Repos
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user