[changelog]
repo_url = "https://github.com/me/project"

Examples¶

Default template¶

Markdown

[v1.2.4] - 2024-04-01 (2024-04-01T12:00:00+00:00)¶

Diff since v1.2.3

abc1234 feat!: drop old API

Breaking changes¶

drop old API

Contributors¶

Alice
Bob

Json

{
  "version": "v1.2.4",
  "date": "2024-04-01",
  "release_datetime_iso": "2024-04-01T12:00:00+00:00",
  "compare_url": "https://github.com/me/project/compare/v1.2.3...v1.2.4",
  "commits": [
    {
      "sha": "abc1234",
      "link": "https://github.com/me/project/commit/abc1234",
      "subject": "feat!: drop old API"
    }
  ],
  "breaking_changes": ["drop old API"],
  "contributors": [
    {"name": "Alice", "link": "https://github.com/alice"},
    {"name": "Bob"}
  ]
}

Keep a Changelog-style header¶

Markdown

[v1.2.4] - 2024-04-01¶

Json

{
  "version": "v1.2.4",
  "date": "2024-04-01"
}

Grouped sections¶

Markdown

Added¶

feat: add greeting command

Fixed¶

fix: correct greeting typo

Json

{
  "added": ["feat: add greeting command"],
  "fixed": ["fix: correct greeting typo"]
}

Compare link¶

Markdown

Diff since v1.2.3

Json

{
  "previous_tag": "v1.2.3",
  "version": "v1.2.4",
  "compare_url": "https://github.com/me/project/compare/v1.2.3...v1.2.4"
}