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
+80
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,86 @@ 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.11.1 (2023-09-22)
8
+
9
+
### Features
10
+
11
+
#### Add a `ChangelogEntry` variable for substitution
12
+
13
+
Anywhere that the existing `Version` variable can be used (for example, in [the `Command` step]), you can now also use `ChangelogEntry` to get the section of the changelog that corresponds to the current version. For example, you could (almost) replicate Knope's GitHub Release creation _without_ Knope's GitHub integration with a workflow like this:
#### Added an `allow_empty` option to the `PrepareRelease` step
41
+
42
+
Closes #416
43
+
44
+
If you want to run `PrepareRelease` on every push to a branch without it failing when there's nothing to release, you can now include the `allow_empty` option like this:
45
+
46
+
```toml
47
+
[[workflows.steps]]
48
+
type = "PrepareRelease"
49
+
allow_empty = true
50
+
```
51
+
52
+
Then, you can use some logic to gracefully skip the rest of your CI process if there is nothing to release. For example, in GitHub Actions, you could do something like this:
53
+
54
+
```yaml
55
+
- name: Prepare Release
56
+
run: knope prepare-release
57
+
- name: Check for Release
58
+
id: status
59
+
run: echo ready=$(if [[ `git status --porcelain` ]]; then echo "true"; else echo "false"; fi;) >> $GITHUB_OUTPUT
60
+
- name: Release
61
+
if: steps.status.outputs.ready == 'true'
62
+
run: knope release
63
+
```
64
+
65
+
This allows you to differentiate between there being nothing to release and the `PrepareRelease` step failing for other reasons.
66
+
67
+
#### New `CreatePullRequest` step
68
+
69
+
The new [`CreatePullRequest` step] allows you to create or update a pull request on GitHub. It's designed to be a nice way to preview and accept new releases via a pull request workflow, but could certainly work for more contexts as well! To see an example of the new PR-based release workflow, check out [Knope's prepare-release workflow] and [Knope's release workflow].
#### Only consider prereleases newer than the last stable
78
+
79
+
This fixes a regression in the previous version of Knope where _all_ prereleases would be considered, rather than just those tagged after the latest stable version.
80
+
81
+
### Documentation
82
+
83
+
#### GitHub Actions Recipes
84
+
85
+
There's a [new section of the docs](https://knope-dev.github.io/knope/github_actions/github_actions.html) with some recipes for using Knope in GitHub Actions. If you have suggestions for additional recipes, please open a [discussion](https://github.com/knope-dev/knope/discussions)!
0 commit comments