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
+76
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,82 @@ 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.8.0 (2023-06-19)
8
+
9
+
### Breaking Changes
10
+
11
+
#### Changelog entries now use 4th level headers instead of bullets
12
+
13
+
In order to support more detailed changelogs via [changesets](https://knope-dev.github.io/knope/config/step/PrepareRelease.html) (like the extra text you're seeing right now!) instead of each change entry being a single bullet under the appropriate category (e.g., `### Breaking Changes` above), it will be a fourth-level header (`####`). So, where _this_ changelog entry would have currently looked like this:
14
+
15
+
```markdown
16
+
### Breaking Changes
17
+
18
+
- Changelog entries now use 4th level headers instead of bullets
19
+
```
20
+
21
+
It now looks like what you're seeing:
22
+
23
+
```markdown
24
+
### Breaking Changes
25
+
26
+
#### Changelog entries now use 4th level headers instead of bullets
27
+
28
+
... recursion omitted
29
+
```
30
+
31
+
If a change note starts with `#### ` already (like in changesets), it will be left alone.
32
+
33
+
### Features
34
+
35
+
#### Move GitHub Release headers up a level (#467, #472)
36
+
37
+
#### Added dates to version titles
38
+
39
+
There are now release dates in both changelogs and version names on GitHub. This probably won't break your releases, but you will have a different format for release notes which could be jarring. The date is in the format `YYYY-MM-DD` and will always be based on UTC time (so if you do a release late at night on the east coast of the United States, the date will be the next day).
40
+
41
+
Previously, the changelog entry title would look like this:
42
+
43
+
```markdown
44
+
## 1.0.0
45
+
```
46
+
47
+
And now it will look like this:
48
+
49
+
```markdown
50
+
## 1.0.0 (2023-06-10)
51
+
```
52
+
53
+
#### Report files to be added to git in `--dry-run`
54
+
55
+
The [`PrepareRelease`](https://knope-dev.github.io/knope/config/step/PrepareRelease.html) adds modified files to Git. Now, when running with the `--dry-run` option, it will report which files would be added to Git (for easier debugging).
56
+
57
+
> Note: The default `knope release` workflow includes this [`PrepareRelease`] step.
58
+
59
+
#### Remove duplicate version from GitHub release name
60
+
61
+
Release notes in GitHub releases used to copy the entire section of the changelog, including the version number. Because the name of the release also includes the version, you'd see the version twice, like:
62
+
63
+
```markdown
64
+
# 1.0.0
65
+
66
+
## 1.0.0
67
+
68
+
... notes here
69
+
```
70
+
71
+
Now, that second `## 1.0.0` is omitted from the body of the release.
72
+
73
+
#### Added support for changesets
74
+
75
+
Leveraging the new [changesets crate](https://github.com/knope-dev/changesets), Knope now supports [changesets](https://github.com/changesets/changesets)! In short, you can run `knope document-change` (if using default workflows) or add the new [`CreateChangeFile`] step to a workflow to generate a new Markdown file in the `.changeset` directory. You can then fill in any additional details below the generated header in the generated Markdown file. The next time the `PrepareRelease` step runs (e.g., in the default `knope release` workflow), all change files will be consumed to help generate a new version and changelog (along with any conventional commits).
0 commit comments