idf-ci v1.4.0: Changelog-Prüfung im Pre-Flight
- Neuer Pre-Flight-Schritt in release-plugin.yml: findet im Block der neuen Version Code in Backticks und Shortcodes ([wort ...], [/wort]) und bricht mit Zeilenangabe ab. Markdown-Links bleiben erlaubt. - Warum: Guide-Regel "Was nicht in den Changelog gehört" (05.11.2026) hängt sonst am Vorsatz dessen, der schreibt. Ältere Blöcke werden nicht geprüft. Refs ideenfabrik/idf-plugin-template#12 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
375ebabc1d
commit
ab6c0cce28
4 files changed
+55
No files matched your search
@@ -197,6 +197,52 @@ jobs:
|
||||
fi
|
||||
echo "Stable tag OK: $STABLE_TAG"
|
||||
|
||||
# Guide-Regel „Was nicht in den Changelog gehört“: der Changelog sagt nur,
|
||||
# was gemacht wurde. Geprüft wird nur der Block der neuen Version, damit
|
||||
# der Altbestand kein Release blockiert.
|
||||
- name: Pre-Flight — Changelog ohne Code und Shortcodes
|
||||
if: steps.vars.outputs.skip != 'true'
|
||||
shell: bash
|
||||
env:
|
||||
VERSION: ${{ steps.vars.outputs.version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
python3 - <<'PY'
|
||||
import re, sys, os
|
||||
version = os.environ["VERSION"]
|
||||
with open("CHANGELOG.md", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
pat = re.compile(
|
||||
r"^##\s+v" + re.escape(version) + r"[^\n]*\n(.*?)(?=^##\s+v\d|^---\s*$|\Z)",
|
||||
re.MULTILINE | re.DOTALL,
|
||||
)
|
||||
m = pat.search(content)
|
||||
if not m:
|
||||
# Fehlender Block meldet der nächste Schritt.
|
||||
sys.exit(0)
|
||||
erste_zeile = content.count("\n", 0, m.start(1)) + 1
|
||||
# Markdown-Links [text](url) sind erlaubt, Shortcodes [wort ...] und [/wort] nicht.
|
||||
link = re.compile(r"\[[^\]\n]*\]\([^)\n]*\)")
|
||||
shortcode = re.compile(r"\[/?[a-z][a-z0-9_-]*(?:\s[^\]\n]*)?\](?![(\[])")
|
||||
funde = []
|
||||
for i, zeile in enumerate(m.group(1).split("\n")):
|
||||
rest = link.sub("", zeile)
|
||||
if "`" in rest:
|
||||
funde.append((erste_zeile + i, "Code in Backticks", zeile))
|
||||
sc = shortcode.search(rest)
|
||||
if sc:
|
||||
funde.append((erste_zeile + i, f"Shortcode {sc.group(0)}", zeile))
|
||||
if not funde:
|
||||
print(f"Changelog v{version} OK: kein Code, keine Shortcodes")
|
||||
sys.exit(0)
|
||||
for nr, art, zeile in funde:
|
||||
print(f"::error file=CHANGELOG.md,line={nr}::{art}: {zeile.strip()[:200]}")
|
||||
print(f"::error::CHANGELOG.md v{version}: {len(funde)} Fund(e). Der Changelog sagt nur, was gemacht wurde: "
|
||||
"keine Shortcodes, kein Code, keine Funktions-, Hook-, Datei- oder Feldnamen, ein Eintrag eine Zeile "
|
||||
"(Guide, Was nicht in den Changelog gehört). Details gehören in Commit, README oder Issue.")
|
||||
sys.exit(1)
|
||||
PY
|
||||
|
||||
- name: Changelog-Block aus CHANGELOG.md extrahieren
|
||||
if: steps.vars.outputs.skip != 'true'
|
||||
id: changelog
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Changelog
|
||||
|
||||
## v1.4.0
|
||||
|
||||
### Hinzugefügt
|
||||
- Der Build bricht ab, wenn im Changelog der neuen Version Code oder Shortcodes stehen, und nennt die betroffenen Zeilen.
|
||||
|
||||
## v1.3.0
|
||||
|
||||
### Geändert
|
||||
|
||||
@@ -87,6 +87,8 @@ Damit der Reusable Workflow durchläuft, müssen im Plugin-Repo vorhanden sein:
|
||||
|
||||
Alle vier Versionen (Tag, Plugin-Header, PHP-Konstante, `Stable tag:`) müssen identisch sein. Der Pre-Flight-Check im Reusable bricht sonst ab.
|
||||
|
||||
Dazu prüft der Pre-Flight den Block der neuen Version in `CHANGELOG.md`: steht dort Code in Backticks oder ein Shortcode (`[wort ...]`, Markdown-Links sind erlaubt), bricht der Build mit Zeilenangabe ab. Regel im Guide: „Was nicht in den Changelog gehört“. Ältere Blöcke prüft er nicht.
|
||||
|
||||
## Aufteilung Changelog-Pflege
|
||||
|
||||
- **`CHANGELOG.md`** ist die **einzige Pflege-Stelle für den Changelog** - einheitlich über alle IDF-Projekte (Software, Flow, Plugins). Du schreibst den neuen Block hier, fertig.
|
||||
|
||||
@@ -66,6 +66,8 @@ Damit der Reusable Workflow durchläuft, müssen im Plugin-Repo vorhanden sein:
|
||||
|
||||
Alle vier Werte (Tag, Plugin-Header-`Version:`, PHP-Konstante, `Stable tag:` in `readme.txt`) müssen identisch sein. Der Pre-Flight-Check im Reusable bricht sonst ab.
|
||||
|
||||
Dazu prüft der Pre-Flight den Block der neuen Version in `CHANGELOG.md`: steht dort Code in Backticks oder ein Shortcode (`[wort ...]`, Markdown-Links sind erlaubt), bricht der Build mit Zeilenangabe ab. Regel im Guide: „Was nicht in den Changelog gehört“. Ältere Blöcke prüft er nicht.
|
||||
|
||||
**Pflege-Aufteilung:** Changelog-Einträge nur in `CHANGELOG.md` pflegen. `readme.txt` bekommt seine `== Changelog ==` beim Release automatisch generiert - manuelle Einträge dort werden überschrieben.
|
||||
|
||||
## Release-Ablauf (Agent/Mensch)
|
||||
|
||||
Reference in new issue
Block a user