Repository navigation
docs(config): clarify split-before-parsing commit processing - #1649
Conversation
Distinguish the legacy pipeline from an explicit processing_order and show how anchored parsers can match unconventional commit body lines. Test the documented configuration alongside legacy and parser-first behavior without changing runtime defaults. Refs orhun#1093
|
Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1649 +/- ##
==========================================
+ Coverage 53.21% 53.33% +0.12%
==========================================
Files 28 28
Lines 2633 2633
==========================================
+ Hits 1401 1404 +3
+ Misses 1232 1229 -3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Regenerate the six platform package entries for version 2.14.2 so the immutable installation used by the NodeJS tarball check succeeds.
|
The failing Links job reports connection refusals for two existing Repology URLs and HTTP 429 for the existing Grindhouse link; none of these URLs is changed by this PR. Could a maintainer rerun the failed job when convenient? I do not have permission to rerun it, and have left the link-check policy unchanged. |
|
Congrats on merging your first pull request! ⛰️ |
Description
Clarify that omitting
processing_orderretains the legacy pipeline: the whole commit is processed before splitting, and each surviving line is then processed again. This distinction matters whenfilter_commitsor a skipping parser discards the whole message before its body lines can be matched.Add a complete split-before-parsing configuration for unconventional messages, plus an example demonstrating that
^fix:keeps two matching body lines without acceptingbugfix:. Replace the ambiguous "default processing order" wording with an explicit opt-in pipeline description.The new unit test parses the documented TOML settings and checks the ordered, legacy, and parser-first cases. Runtime behavior and defaults are unchanged.
Also regenerate
npm/git-cliff/yarn.lockfor the six already-published2.14.2platform packages. The stale2.13.1entries made CI's immutable installation fail before the NodeJS tarball could be validated.Motivation and Context
Related to #1093 and the compatibility discussion in #1201/#1532. This documents the existing workaround instead of changing the default behavior. The approach was described in the issue discussion before making the change; maintainer review is still pending.
Prepared with assistance from OpenAI Codex; the changes and validation results were reviewed before submission.
How Has This Been Tested?
On macOS arm64 with Rust 1.97.1:
cargo test --locked -- --skip repo::test::git_upstream_remote: 150 unit/integration tests and two doctests passed.cargo test --locked --all-features -- --skip repo::test::git_upstream_remote: 150 unit/integration tests and two doctests passed.cargo test --locked --no-default-features -- --skip repo::test::git_upstream_remote: 122 unit/integration tests and two doctests passed.cargo clippy --locked --tests -- -D warningspassed.yarn buildinwebsitepassed.Fixedentries, while the legacy configuration emitted no entries.An isolated fork preflight passed 6/6 jobs against the exact proposed commit
a0b4219fa9150ee69ebc636bb948ef326752a144: full default suites on Linux/macOS; additional all-feature/no-default suites on Linux; the pipeline tests on Windows; nightly formatting/clippy; the Node 20 website build; and repository spelling. Its workflow lives on a separate fork-only branch and is not part of this PR.The repository's CI also skips
repo::test::git_upstream_remote; this is a live remote test, not a regression introduced by this change.Upstream CI notes
YN0028, also reproduced on untouched base60e0be97e945f71148172675be82399d382c9677. Follow-up commitfdc96b4regenerates the six lockfile entries to match the manifest's2.14.2dependencies. Locally, immutable installation, package build, and verification of all ten expected tarball files now pass. The future release-lockfile automation remains covered by fix(cd): open a pull request that updates yarn.lock after the npm release #1648.website/blog/git-cliff-2.9.0.md, and connection-refused errors for two Repology URLs inwebsite/docs/installation/index.md. These URLs and both source files are unchanged from the base commit. This PR adds no external URLs.The six-job fork preflight above covers
a0b4219. On follow-upfdc96b4, the same upstream Check NodeJS tarball now passes. Link checks remain enabled.Screenshots / Logs (if applicable)
Types of Changes
Checklist: