Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use commits with slightly invalid messages in release notes #105

Merged
merged 2 commits into from
Nov 15, 2024

Conversation

apricote
Copy link
Owner

@apricote apricote commented Nov 15, 2024

Fixes a bug where commits with messages that do not strictly conform to
conventional commits spec would be ignored. This could easily happen
while parsing footers like "Closes #xx" which would start the footer
section, while continuing with the body afterwards.

This solution has two downsides:

  • these warnings are not surfaced to the user.
  • If a BREAKING CHANGE footer exists after the parsing issue it is ignored

Thanks to @jooola for the bug report and test case.

Closes #99 #100

jooola and others added 2 commits November 15, 2024 15:12
Fixes a bug where commits with messages that do not strictly conform to
conventional commits spec would be ignored. This could easily happen
while parsing footers like "Closes #xx" which would start the footer
section, while continuing with the body afterwards.

This solution has two downsides:

- these warnings are not surfaced to the user.
- If a `BREAKING CHANGE` footer exists after the parsing issue it is ignored
@apricote apricote added the bug Something isn't working label Nov 15, 2024
@apricote apricote changed the title fix: use commits with slightly invalid messages fix: use commits with slightly invalid messages in release notes Nov 15, 2024
@apricote apricote merged commit 0ae2d90 into main Nov 15, 2024
7 checks passed
@apricote apricote deleted the parse-commit-with-body branch November 15, 2024 16:25
apricote pushed a commit to hetznercloud/fleeting-plugin-hetzner that referenced this pull request Nov 15, 2024
…etznercloud/fleeting-plugin-hetzner!172)

This MR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [apricote/releaser-pleaser](https://gitlab.com/apricote/releaser-pleaser) | repository | minor | `v0.4.2` -> `v0.5.0` |

---

### Release Notes

<details>
<summary>apricote/releaser-pleaser (apricote/releaser-pleaser)</summary>

### [`v0.5.0`](https://gitlab.com/apricote/releaser-pleaser/blob/HEAD/CHANGELOG.md#v050)

[Compare Source](https://gitlab.com/apricote/releaser-pleaser/compare/v0.4.2...v0.5.0)

##### Features

-   **gitlab**: make job dependencies configurable and run immediately ([#&#8203;101](apricote/releaser-pleaser#101))
-   **github**: mark pre-releases correctly ([#&#8203;110](apricote/releaser-pleaser#110))

##### Bug Fixes

-   use commits with slightly invalid messages in release notes ([#&#8203;105](apricote/releaser-pleaser#105))
-   create CHANGELOG.md if it does not exist ([#&#8203;108](apricote/releaser-pleaser#108))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNy4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTcuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing commit from changelog after commit parsing failed
2 participants