docs: add CHANGELOG.md and documentation overview
- CHANGELOG.md (Keep a Changelog, German) for 0.1.0, 0.1.1 and unreleased documentation work, incl. "Beim Update zu tun" - README: documentation table (manual, how it works, changelog, license) - manual: release steps now include updating CHANGELOG/FUNKTIONSWEISE Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
d9e495d36a
commit
aec824d8be
1 changed files with 64 additions and 4 deletions
|
|
@ -840,9 +840,11 @@ src/mdgrep/
|
|||
Neue Version veröffentlichen:
|
||||
|
||||
1. Version in `pyproject.toml` **und** `src/mdgrep/__init__.py` erhöhen (bei Widget-Änderungen auch im Kopf von `mdgrep-widget.js`)
|
||||
2. Tests laufen lassen: `.venv/bin/pytest`
|
||||
3. Commit, Tag und Push: `git tag -a v0.1.2 -m "mdgrep 0.1.2" && git push origin main --tags`
|
||||
4. In den nutzenden Projekten den Tag in `requirements.txt` anpassen und `pip install -r requirements.txt`
|
||||
2. `CHANGELOG.md`: Abschnitt `[Unreleased]` in die neue Version umbenennen (mit Datum), „Beim Update zu tun"
|
||||
ergänzen; bei Änderungen am inneren Aufbau auch `FUNKTIONSWEISE.md` aktualisieren
|
||||
3. Tests laufen lassen: `.venv/bin/pytest`
|
||||
4. Commit, Tag und Push: `git tag -a v0.1.2 -m "mdgrep 0.1.2" && git push origin main --tags`
|
||||
5. In den nutzenden Projekten den Tag in `requirements.txt` anpassen und `pip install -r requirements.txt`
|
||||
ausführen; laufende Dienste neu starten.
|
||||
|
||||
Versionsregel: Änderungen an öffentlichen Funktionen, am JSON-Format oder an Widget-Optionen, die
|
||||
|
|
|
|||
Loading…
Reference in a new issue