Skip to content

Commit 55a5f21

Browse files
committed
chore: Release v0.10.0
Signed-off-by: Jean Mertz <[email protected]>
1 parent e7da04b commit 55a5f21

File tree

4 files changed

+59
-4
lines changed

4 files changed

+59
-4
lines changed

CHANGELOG.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The format is based on [Keep a Changelog], and this project adheres to
1212
## Overview
1313

1414
- [unreleased](#unreleased)
15+
- [`0.10.0`](#0.10.0)_2025.06.10_
1516
- [`0.9.0`](#0.9.0)_2025.06.10_
1617
- [`0.8.0`](#0.8.0)_2025.06.09_
1718
- [`0.7.0`](#0.7.0)_2025.06.09_
@@ -27,6 +28,38 @@ The format is based on [Keep a Changelog], and this project adheres to
2728

2829
_nothing new to show for… yet!_
2930

31+
<a id="0.10.0" />
32+
33+
## [0.10.0]
34+
35+
_2025.06.10_
36+
### Changes
37+
38+
#### Bug Fixes
39+
40+
- **handle empty release notes** ([`f0274d6`])
41+
42+
- **write to stdout by default, as intended** ([`e08fb2c`])
43+
44+
- **resolve newline formatting in default template** ([`c3ae8ed`])
45+
46+
#### Features
47+
48+
- **`--strip-config` excludes metadata from rendered changelog** ([`b0dcc8a`])
49+
50+
This change introduces a new command line option that allows users to
51+
generate changelog output without the inline configuration metadata.
52+
When the `--strip-config` flag is provided, the rendered changelog will
53+
omit any metadata section that would normally be appended.
54+
55+
This is useful when you want to render a template to stdout without
56+
overwriting the file itself that contains the metadata. You can use this
57+
to have dedicated "template" files that Jilu can use to render to
58+
stdout. For example; if you have a `tag.md` file that contains only
59+
metadata with a custom `Template` section, you can use it to render the
60+
contents of a tag, pipe the output to a file, and use that file as the
61+
input for the tag message.
62+
3063
<a id="0.9.0" />
3164

3265
## [0.9.0]_Back to our roots!_
@@ -135,20 +168,36 @@ Here’s how you can create the relevant release commit and tag in a shell
135168
script:
136169

137170
```sh
171+
# Create a temporary file to store the change log JSON output. This is
172+
# required, because using `--edit` requires stdout to be a TTY for our
173+
# editor, so we need to write the JSON output to a file instead of
174+
# stdout.
138175
release=$(mktemp)
139176

177+
# 1. We group the unreleased changes in a new release 0.9.0
178+
# 2. We edit the release notes in our $EDITOR
179+
# 3. We write the changes to our CHANGELOG.md
180+
# 4. We return the change log data as JSON to stdout
181+
# 5. We filter the JSON to the latest release (0.9.0)
182+
# 6. We write the JSON output to our temporary file
140183
jilu --release=v0.9.0 \
141184
--edit \
142185
--write \
143186
--output=json \
144187
--jq='.releases[0]' \
145188
--output-file="$release"
146189

190+
# 1. We make sure to stage the change log changes
147191
git add CHANGELOG.md
148192

193+
# 1. We use `jq -r` to produce a raw (unquoted) string for us
194+
# 2. We create a new release commit message
195+
# 3. We commit the staged changes
149196
msg=$(echo "$release" | jq -r '"chore: Release v" + .version')
150197
git commit --message "$msg"
151198

199+
# 1. We create a new release tag message
200+
# 2. We create the tag
152201
msg=$(echo "$release" | jq -r '[.subject, .notes] | join("\n\n")')
153202
git tag --sign --message "$msg"
154203
```
@@ -745,7 +794,8 @@ Be sure to check out the project [README] if you haven't already!
745794
746795
<!-- [releases] -->
747796
748-
[unreleased]: https://github.com/rustic-games/jilu/compare/v0.9.0...HEAD
797+
[unreleased]: https://github.com/rustic-games/jilu/compare/v0.10.0...HEAD
798+
[0.10.0]: https://github.com/rustic-games/jilu/releases/tag/v0.10.0
749799
[0.9.0]: https://github.com/rustic-games/jilu/releases/tag/v0.9.0
750800
[0.8.0]: https://github.com/rustic-games/jilu/releases/tag/v0.8.0
751801
[0.7.0]: https://github.com/rustic-games/jilu/releases/tag/v0.7.0
@@ -759,6 +809,10 @@ Be sure to check out the project [README] if you haven't already!
759809
760810
<!-- [commits] -->
761811
812+
[`f0274d6`]: https://github.com/rustic-games/jilu/commit/f0274d6d85f30edad1659bcb8fe2396d2e87f1e7
813+
[`e08fb2c`]: https://github.com/rustic-games/jilu/commit/e08fb2c5f5183de3508832c63b627d29cce98cce
814+
[`b0dcc8a`]: https://github.com/rustic-games/jilu/commit/b0dcc8a5e9eb4d6ea1a1c60156f34e0a6a61e6db
815+
[`c3ae8ed`]: https://github.com/rustic-games/jilu/commit/c3ae8ed436504756aee87a82be06ec4b8ade2627
762816
[`e52d264`]: https://github.com/rustic-games/jilu/commit/e52d26449f430dbf8a066d9d005cee8a273f1873
763817
[`391a952`]: https://github.com/rustic-games/jilu/commit/391a9525a6b824e81073be36d6570fb456eba51e
764818
[`83e7793`]: https://github.com/rustic-games/jilu/commit/83e7793ab13dcf9739f0d76684ef0e9c08b98ee4
@@ -795,6 +849,7 @@ Be sure to check out the project [README] if you haven't already!
795849
<!-- [pull requests] -->
796850
797851
852+
798853
<!--
799854
Config(
800855
github: ( repo: "rustic-games/jilu" ),

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "jilu"
3-
version = "0.9.0"
3+
version = "0.10.0"
44
authors = ["Jean Mertz <[email protected]>"]
55
license = "MIT OR Apache-2.0"
66
description = "Generate a change log based on conventional commits."

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ What matters most is the success of your project, with or without the help of
4949
- Using [release binaries]:
5050

5151
```shell
52-
curl -L https://github.com/rustic-games/jilu/releases/download/v0.9.0/jilu_$(uname)_x86_64.tar.gz | tar -xvf - jilu
52+
curl -L https://github.com/rustic-games/jilu/releases/download/v0.10.0/jilu_$(uname)_x86_64.tar.gz | tar -xvf - jilu
5353
```
5454

5555
- ~~Using [Homebrew]~~ _(soon)_:

0 commit comments

Comments
 (0)