Changelog automatisieren

Warum automatisieren?

Manuelle Changelog-Pflege ist muehsam, fehleranfaellig und wird oft vergessen. Automatisierung stellt sicher, dass jedes Release dokumentiert wird — und deine Nutzer informiert bleiben.

Drei Ansaetze zur Automatisierung

1. Conventional Commits

Verwende ein standardisiertes Commit-Message-Format, um Changelogs automatisch zu generieren:

feat: add dark mode toggle
fix: resolve widget loading on Safari
docs: update API authentication guide
BREAKING CHANGE: remove v1 API endpoints

2. CI/CD-Pipeline

Veroeffentliche Changelog-Eintraege als Teil deiner Release-Pipeline:

# GitHub Actions example
- name: Publish changelog
  run: |
    curl -X POST https://deplyd.dev/api/v1/entries \
      -H "Authorization: Bearer $DPL_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"title": "${{ github.event.release.name }}",
           "body": "${{ github.event.release.body }}",
           "type": "feature"}'

3. API-First mit Deplyd

Nutze die Deplyd REST API, um Changelog-Eintraege aus jedem System zu erstellen — deiner CI-Pipeline, einem Slack-Bot oder einem eigenen Admin-Tool. Eintraege sind sofort per Widget, auf der Changelog-Seite und per E-Mail verfuegbar.

Tool-Vergleich

Best Practices

1. Fuehre eine Commit-Konvention ein (Conventional Commits funktioniert gut).
2. Binde die Changelog-Veroeffentlichung in deine CI/CD-Pipeline ein.
3. Pruefe automatisch generierte Eintraege immer vor der Veroeffentlichung.
4. Benachrichtige Nutzer ueber mehrere Kanaele — Widget, E-Mail und deine Changelog-Seite.