Skip to content

0.8.0 (2023-06-19)
Compare
Choose a tag to compare
@dbanty dbanty released this 19 Jun 01:17
· 842 commits to main since this release
v0.8.0
bdc8149
This commit was signed with the committer’s verified signature.
dbanty Dylan Anthony
GPG key ID: 46797152293CE824
Verified
Learn about vigilant mode.

Breaking Changes

Changelog entries now use 4th level headers instead of bullets

In order to support more detailed changelogs via changesets (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:

## Breaking Changes

- Changelog entries now use 4th level headers instead of bullets

It now looks like what you're seeing:

## Breaking Changes

### Changelog entries now use 4th level headers instead of bullets

... recursion omitted

If a change note starts with #### already (like in changesets), it will be left alone.

Features

Move GitHub Release headers up a level (#467, #472)

Added dates to version titles

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).

Previously, the changelog entry title would look like this:

# 1.0.0

And now it will look like this:

# 1.0.0 (2023-06-10)

Report files to be added to git in --dry-run

The PrepareRelease 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).

Note: The default knope release workflow includes this [PrepareRelease] step.

Remove duplicate version from GitHub release name

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:

# 1.0.0

# 1.0.0

... notes here

Now, that second ## 1.0.0 is omitted from the body of the release.

Added support for changesets

Leveraging the new changesets crate, Knope now supports 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).

For additional details, see:

Assets 6
Loading