Changelog

In Knope changelog is a Markdown file which documents every change relevant to users for a package. The format of a changelog looks like this:

# Some optional title for the changelog

Some details about how versioning works, how to read the changelog, etc.

## 2.0.0 (2023-02-01)

### Breaking changes

#### A breaking change

## 1.2.3 (2022-12-03)

### Fixes

#### A fix

Tip

You can customize your changelogs in a number of ways.

Changelogs have a number of parts:

Title (optional)

Most, but not all Markdown files start with a title. This should probably be # Changelog or # My Package Changelog.

Introduction (optional)

It’s a good idea to explain to your consumers how changes work for this package. At a minimum, describe what’s considered a breaking change for your package, as this looks different for different packages.

Versions

Each version starts with a heading (default level 2, ##) with the version number and the release data, formatted like this:

## 1.2.3 (2022-12-03)

Following the version heading, there is at least one section heading (one level below the version heading) grouping changes by type, for example “Breaking changes” or “Features.”

### Breaking changes

Following the section heading, there is at least one change heading (two levels below the version heading) describing a single change:

#### A breaking change

After each change heading, there is optionally a description of the change. Put all together, a version looks something like this:

## 1.2.3 (2022-12-03)

### Breaking changes

#### A breaking change

This is a description of the breaking change.

### Fixes

#### A fix

#### Another fix

Knope sorts versions from newest to oldest, so the most recent version is near the top of the changelog right after the optional title and introduction.