Skip to content

fix(release): add proper newline after New Contributors section in cliff template#6194

Merged
jdx merged 1 commit intomainfrom
fix-cliff-template-newlines
Sep 5, 2025
Merged

fix(release): add proper newline after New Contributors section in cliff template#6194
jdx merged 1 commit intomainfrom
fix-cliff-template-newlines

Conversation

@jdx
Copy link
Owner

@jdx jdx commented Sep 5, 2025

Summary

  • Fixes the changelog formatting issue where there was an extra blank line between the last commit and the New Contributors section
  • Removes unnecessary whitespace for cleaner changelog formatting

Problem

The changelog in PR #6192 and release v2025.9.1 had an extra blank line between the bug fixes and the New Contributors section:

### 🐛 Bug Fixes

- python nested venv path order by [@elvismacak]...
- resolve immutable release workflow...


### New Contributors

This extra blank line made the changelog look inconsistent and poorly formatted.

Solution

Changed the cliff.toml template to:

  1. Add - to the end of {% endfor -%} on line 41 to strip trailing whitespace
  2. Remove the blank line between the if statement and "### New Contributors" heading

The template now properly strips whitespace between sections while maintaining clean separation.

Test

Tested by generating release notes for v2025.9.1:

git cliff --strip all --tag v2025.9.1 v2025.9.0..v2025.9.1

Result shows proper formatting with no extra blank lines:

### 🐛 Bug Fixes

- python nested venv path order by [@elvismacak]...
- resolve immutable release workflow...

### New Contributors

- @elvismacak made their first contribution...

Test plan

  • Generate changelog with git cliff and verify no extra blank lines
  • Verify proper spacing between all sections
  • Check that version headers are properly separated

🤖 Generated with Claude Code

…iff template

The previous fix to remove extra blank lines inadvertently caused the
New Contributors section to run into the next version header. This adds
a blank line after the contributor list to ensure proper separation
between sections.

This ensures the changelog has clean formatting with:
- No extra blank lines between commits within sections
- Proper blank line after the New Contributors section
- Clear separation between version releases

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings September 5, 2025 15:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Fixes changelog formatting where the New Contributors section was incorrectly running into the next version header due to a template newline handling issue.

  • Changed Jinja template to properly preserve newlines after the contributor list
  • Added a blank line between the contributors section and subsequent content

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jdx jdx merged commit c95426a into main Sep 5, 2025
18 checks passed
@jdx jdx deleted the fix-cliff-template-newlines branch September 5, 2025 15:22
@github-actions
Copy link

github-actions bot commented Sep 5, 2025

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.9.1 x -- echo 20.2 ± 0.8 18.7 23.4 1.00
mise x -- echo 21.0 ± 1.0 19.3 26.2 1.04 ± 0.06

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.9.1 env 19.4 ± 0.8 18.1 24.1 1.00
mise env 20.2 ± 0.9 18.4 23.8 1.04 ± 0.06

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.9.1 hook-env 19.0 ± 0.7 17.7 21.7 1.00
mise hook-env 19.2 ± 0.9 17.8 24.5 1.01 ± 0.06

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.9.1 ls 17.2 ± 0.6 16.0 19.2 1.00 ± 0.05
mise ls 17.1 ± 0.7 16.0 19.5 1.00

xtasks/test/perf

Command mise-2025.9.1 mise Variance
install (cached) 166ms ✅ 106ms +56%
ls (cached) 63ms 63ms +0%
bin-paths (cached) 67ms 67ms +0%
task-ls (cached) 474ms 486ms -2%

✅ Performance improvement: install cached is 56%

jdx pushed a commit that referenced this pull request Sep 5, 2025
### 🐛 Bug Fixes

- **(ci)** set required environment variables for npm publishing by
[@jdx](https://github.com/jdx) in
[#6189](#6189)
- **(release)** clean up extra newlines in release notes formatting by
[@jdx](https://github.com/jdx) in
[#6190](#6190)
- **(release)** add proper newline after New Contributors section in
cliff template by [@jdx](https://github.com/jdx) in
[#6194](#6194)
- **(release)** fix changelog formatting to remove extra blank lines by
[@jdx](https://github.com/jdx) in
[#6195](#6195)
- **(release)** restore proper newline after New Contributors section by
[@jdx](https://github.com/jdx) in
[#6196](#6196)

### 🚜 Refactor

- **(ci)** split release workflow into separate specialized workflows by
[@jdx](https://github.com/jdx) in
[#6193](#6193)

### Chore

- **(release)** require GitHub Actions environment for release-plz
script by [@jdx](https://github.com/jdx) in
[#6191](#6191)
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request Sep 8, 2025
## [2025.9.5](https://github.com/jdx/mise/compare/v2025.9.4..v2025.9.5) - 2025-09-06

### 🚀 Features

- **(task)** add timeout support for task execution by @jdx in [#6216](jdx/mise#6216)
- **(task)** sub-tasks in run lists by @jdx in [#6212](jdx/mise#6212)

### Chore

- fix npm publish action by @jdx in [14f4b09](jdx/mise@14f4b09)
- fix cloudflare release action by @jdx in [00afa25](jdx/mise@00afa25)
- fix git-cliff for release notes by @jdx in [15a9aed](jdx/mise@15a9aed)

## [2025.9.4](https://github.com/jdx/mise/compare/v2025.9.3..v2025.9.4) - 2025-09-06

### Chore

- fix git-cliff on release by @jdx in [3c388f2](jdx/mise@3c388f2)

## [2025.9.3](https://github.com/jdx/mise/compare/v2025.9.2..v2025.9.3) - 2025-09-06

### 🚀 Features

- **(backend)** improve http error when platform url missing; list available platforms by @jdx in [#6200](jdx/mise#6200)
- **(cli)** support scoped packages for all backend types by @earlgray283 in [#6213](jdx/mise#6213)
- **(http)** add URL replacement feature for HTTP requests by @ThomasSteinbach in [#6207](jdx/mise#6207)

### 🐛 Bug Fixes

- **(backend)** preserve arch underscores in platform keys by @jdx in [#6202](jdx/mise#6202)
- **(task)** resolve hanging issue with multiple depends_post by @jdx in [#6206](jdx/mise#6206)
- couldn't download node binary in Alpine, even if it exists in the mirror url by @Hazer in [#5972](jdx/mise#5972)
- **breaking** use config_root for env._.path by @jdx in [#6204](jdx/mise#6204)
- bugfix for paths that include spaces by @karim-elkholy in [#6210](jdx/mise#6210)

### 📚 Documentation

- improve release notes generation by @jdx in [#6197](jdx/mise#6197)
- fix release changelog contributor reporting by @jdx in [#6201](jdx/mise#6201)

### Chore

- use fine-grained gh token by @jdx in [#6208](jdx/mise#6208)
- use settings.local.json for claude config by @jdx in [fd0fba9](jdx/mise@fd0fba9)

### New Contributors

- @ThomasSteinbach made their first contribution in [#6207](jdx/mise#6207)
- @earlgray283 made their first contribution in [#6213](jdx/mise#6213)
- @karim-elkholy made their first contribution in [#6210](jdx/mise#6210)
- @Hazer made their first contribution in [#5972](jdx/mise#5972)

## [2025.9.2](https://github.com/jdx/mise/compare/v2025.9.1..v2025.9.2) - 2025-09-05

### 🐛 Bug Fixes

- **(ci)** set required environment variables for npm publishing by @jdx in [#6189](jdx/mise#6189)
- **(release)** clean up extra newlines in release notes formatting by @jdx in [#6190](jdx/mise#6190)
- **(release)** add proper newline after New Contributors section in cliff template by @jdx in [#6194](jdx/mise#6194)
- **(release)** fix changelog formatting to remove extra blank lines by @jdx in [#6195](jdx/mise#6195)
- **(release)** restore proper newline after New Contributors section by @jdx in [#6196](jdx/mise#6196)

### 🚜 Refactor

- **(ci)** split release workflow into separate specialized workflows by @jdx in [#6193](jdx/mise#6193)

### Chore

- **(release)** require GitHub Actions environment for release-plz script by @jdx in [#6191](jdx/mise#6191)

## [2025.9.1](https://github.com/jdx/mise/compare/v2025.9.0..v2025.9.1) - 2025-09-05

### 🐛 Bug Fixes

- python nested venv path order by @elvismacak in [#6124](jdx/mise#6124)
- resolve immutable release workflow and VERSION file timing issues by @jdx in [#6187](jdx/mise#6187)

### New Contributors

- @elvismacak made their first contribution in [#6124](jdx/mise#6124)

## [2025.9.0](https://github.com/jdx/mise/compare/v2025.8.21..v2025.9.0) - 2025-09-05

### 🚀 Features

- allow set/unset backend aliases by @roele in [#6172](jdx/mise#6172)

### 🐛 Bug Fixes

- **(aqua)** respect order of asset_strs by @risu729 in [#6143](jdx/mise#6143)
- **(java)** treat freebsd as linux (assuming linux compatability) by @roele in [#6161](jdx/mise#6161)
- **(nushell/windows)** Fix $env.PATH getting converted to a string by @zackyancey in [#6157](jdx/mise#6157)
- **(sync)** create uv_versions_path dir if it doesn't exist by @risu729 in [#6142](jdx/mise#6142)
- **(ubi)** show relevent error messages for v-prefixed tags by @risu729 in [#6183](jdx/mise#6183)
- remove nodejs/golang alias migrate code by @risu729 in [#6141](jdx/mise#6141)
- mise activate not working on powershell v5 by @L0RD-ZER0 in [#6168](jdx/mise#6168)

### 📚 Documentation

- **(task)** remove word "additional" to avoid confusions by @risu729 in [#6159](jdx/mise#6159)

### Chore

- update Cargo.lock by @risu729 in [#6184](jdx/mise#6184)

### New Contributors

- @zackyancey made their first contribution in [#6157](jdx/mise#6157)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants