You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CHANGELOG.md
+38
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,44 @@ All notable changes to this project will be documented in this file.
4
4
5
5
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
6
7
+
## 0.13.0 (2023-10-22)
8
+
9
+
### Breaking Changes
10
+
11
+
#### Change changeset title level
12
+
13
+
The level of the title of a changeset no longer impacts the level of the release header in the changelog. To make this more obvious, changeset title are now level one headers by default. This is a breaking change because older versions of Knope will no longer properly handle the changesets from newer versions of Knope.
14
+
15
+
#### Change where new versions are inserted in changelog
16
+
17
+
In practice, this will not impact most changelogs, however, previous versions of Knope looked for the first header at a certain level (e.g., starting with `## `) and inserted the new version right before that. Now, Knope looks for the first header that is parseable as a semver version (e.g., `## 1.2.3`) and inserts the new version right before that.
18
+
19
+
This _will_ make it harder to adopt Knope in projects that have an existing changelog which is not of the same format,
20
+
but it makes inserting the new version in the changelog more robust.
21
+
22
+
### Features
23
+
24
+
#### Allow overriding built-in changelog sections
25
+
26
+
If you don't want to use the default changelog sections of "Breaking changes", "Features",
27
+
and "Fixes", you can now override them by using the equivalent changeset types!
28
+
Overriding them resets their position in the changelog, so you probably want to reset _all_ of them if you reset any.
29
+
This looks like:
30
+
31
+
```toml
32
+
[package]
33
+
extra_changelog_sections = [
34
+
{ type = "major", name = "❗️Breaking ❗" },
35
+
{ type = "minor", name = "🚀 Features" },
36
+
{ type = "patch", name = "🐛 Fixes" },
37
+
{ footer = "Changelog-Note", name = "📝 Notes" },
38
+
]
39
+
```
40
+
41
+
#### Support level-one release headers in changelogs
42
+
43
+
If the last release in a changelog file has a level-one header instead of Knope's default of level-two, new releases will be created with level-one headers as well. Sections will then be level two instead of level three.
0 commit comments