Automate Your Changelog

Why automate?

Manual changelog maintenance is tedious, error-prone, and often forgotten. Automation ensures every release gets documented — and your users stay informed.

Three approaches to automation

1. Conventional Commits

Use a standardized commit message format to generate changelogs automatically:

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

Publish changelog entries as part of your 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 with Deplyd

Use the Deplyd REST API to create changelog entries from any system — your CI pipeline, a Slack bot, or a custom admin tool. Entries are instantly available via the widget, the public changelog page, and email notifications.

Tool comparison

Best practices

1. Adopt a commit convention (Conventional Commits works well).
2. Wire changelog publishing into your CI/CD pipeline.
3. Always review auto-generated entries before publishing.
4. Notify users through multiple channels — widget, email, and your changelog page.