Skip to content

Commit b263572

Browse files
dbantyGitHub
and
GitHub
authored
chore: prepare release 0.16.1 (#961)
This PR was created by Knope. Merging it will create a new release ### Features #### Add `help_text` option to workflows `[[workflows]]` can now have `help_text`: Example: ```toml [[workflows]] name = "release" help_text = "Prepare a release" ``` The message is displayed when running `knope --help`: ```text A command line tool for automating common development tasks Usage: knope [OPTIONS] [COMMAND] Commands: release Prepare a release help Print this message or the help of the given subcommand(s) ... ``` PR #960 closes issue #959. Thanks @alex-way! #### Use bullets to describe simple changes The previous changelog & forge release format used headers for the summary of all changes, these entries were hard to follow for simple changes like this: ```markdown ### Features #### A feature #### Another header with no content in between? ``` Now, _simple_ changes are described with bullets at the _top_ of the section. More complex changes will come after any bullets, using the previous format: ```markdown ### Features - A simple feature - Another simple feature #### A complex feature Some details about that feature ``` Right now, a simple change is any change which comes from a conventional commit (whether from the commit summary or from a footer) _or_ a changeset with only a header in it. Here are three simple changes: ``` feat: A simple feature Changelog-Note: A note entry ``` ```markdown --- default: minor --- # A simple feature with no description ``` A complex change is any changeset which has content (not just empty lines) below the header. PR #969 implemented #930. Thanks for the suggestion @ematipico! Co-authored-by: GitHub <[email protected]>
1 parent 61bdab9 commit b263572

4 files changed

+81
-83
lines changed

.changeset/add_help_text_to_workflow_arguments_in_knopetoml.md

-31
This file was deleted.

.changeset/use_bullets_to_describe_simple_changes.md

-51
This file was deleted.

CHANGELOG.md

+80
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,86 @@ The results are changes to the current directory, calls to external commands, an
1010
Notably, anything written to standard output or standard error
1111
(what you see in the terminal) is _not_ considered part of the public API and may change between any versions.
1212

13+
## 0.16.1 (2024-03-24)
14+
15+
### Features
16+
17+
#### Add `help_text` option to workflows
18+
19+
`[[workflows]]` can now have `help_text`:
20+
21+
Example:
22+
23+
```toml
24+
[[workflows]]
25+
name = "release"
26+
help_text = "Prepare a release"
27+
```
28+
29+
The message is displayed when running `knope --help`:
30+
31+
```text
32+
A command line tool for automating common development tasks
33+
34+
Usage: knope [OPTIONS] [COMMAND]
35+
36+
Commands:
37+
release Prepare a release
38+
help Print this message or the help of the given subcommand(s)
39+
40+
...
41+
```
42+
43+
PR #960 closes issue #959. Thanks @alex-way!
44+
45+
#### Use bullets to describe simple changes
46+
47+
The previous changelog & forge release format used headers for the summary of all changes, these entries were hard
48+
to follow for simple changes like this:
49+
50+
```markdown
51+
### Features
52+
53+
#### A feature
54+
55+
#### Another header with no content in between?
56+
```
57+
58+
Now, _simple_ changes are described with bullets at the _top_ of the section. More complex changes will come after
59+
any bullets, using the previous format:
60+
61+
```markdown
62+
### Features
63+
64+
- A simple feature
65+
- Another simple feature
66+
67+
#### A complex feature
68+
69+
Some details about that feature
70+
```
71+
72+
Right now, a simple change is any change which comes from a conventional commit (whether from the commit summary or
73+
from a footer) _or_ a changeset with only a header in it. Here are three simple changes:
74+
75+
```
76+
feat: A simple feature
77+
78+
Changelog-Note: A note entry
79+
```
80+
81+
```markdown
82+
---
83+
default: minor
84+
---
85+
86+
# A simple feature with no description
87+
```
88+
89+
A complex change is any changeset which has content (not just empty lines) below the header.
90+
91+
PR #969 implemented #930. Thanks for the suggestion @ematipico!
92+
1393
## 0.16.0 (2024-03-20)
1494

1595
### Breaking Changes

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "knope"
33
description = "A command line tool for automating common development tasks"
4-
version = "0.16.0"
4+
version = "0.16.1"
55
authors = ["Dylan Anthony <[email protected]>"]
66
edition = "2021"
77
license = "MIT"

0 commit comments

Comments
 (0)