test(fixtures): add include-path multi-value handling tests by niklasmarderx · Pull Request #1456 · orhun/git-cliff

niklasmarderx · 2026-03-31T13:46:13Z

Add two fixture tests that verify --include-path handles multiple glob patterns correctly (#1455):

test-include-path-repeated-flag: --include-path 'website/**/*' --include-path 'docs/**/*'
test-include-path-space-separated: --include-path 'website/**/* docs/**/*'

Both use the same commit history (files in website/, src/, and docs/) and expect the same filtered output — only commits touching website/ or docs/ paths.

Closes #1455

Add two fixture tests that verify --include-path works correctly with multiple glob patterns: - test-include-path-repeated-flag: uses separate --include-path flags - test-include-path-space-separated: uses a single flag with space-separated globs Both should produce identical output, filtering commits to only those that touch files matching the given patterns. Closes orhun#1455

orhun · 2026-04-03T16:56:31Z

Hey, thanks for the PR!

The workflow entries for test-fixtures.yml need to be added separately since fork pushes can't modify workflow files. Here's what to add to the matrix:

Is that a new limitation that GitHub has? I think you should be able to change those files in your fork and push them to this PR, no?

niklasmarderx · 2026-04-04T09:02:04Z

You're right, I was mistaken — just pushed the workflow entries in e03d189. Should be good now.

codecov-commenter · 2026-04-04T09:06:39Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.35%. Comparing base (0a69719) to head (7fa13a5).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1456      +/-   ##
==========================================
- Coverage   47.45%   47.35%   -0.09%     
==========================================
  Files          24       24              
  Lines        2131     2131              
==========================================
- Hits         1011     1009       -2     
- Misses       1120     1122       +2

Flag	Coverage Δ
unit-tests	`47.35% <ø> (-0.09%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ognis1205

A couple of points regarding the fixture tests:

Newly added fixture tests should all pass in CI.
The following case seems to be missing, could you add it?

Environment variable with space-separated globs:
export GIT_CLIFF_INCLUDE_PATH="website/**/* .github/**/*"
git cliff

Ideally, each fixture test should correspond to a single expected output. However, given the current CI setup, this is not straightforward. As a workaround, please add a comment in workflow/test-fixtures.yml indicating that the three fixture test entries should use identical expected.md content.

niklasmarderx · 2026-04-04T18:46:44Z

I'll fix it

@ognis1205

Fixes: - Fix expected.md for repeated-flag and space-separated tests: bug fixes were in wrong order (alphabetical instead of chronological). git-cliff outputs commits by timestamp, so 'Update installation guide' (01:25:11) comes before 'Fix website styles' (01:25:12). New test: - Add test-include-path-env-var fixture: verifies that setting GIT_CLIFF_INCLUDE_PATH='website/**/* docs/**/*' as an environment variable produces the same output as the CLI flag variants. Workflow: - Add explanatory comment that all three include-path fixture tests use identical expected.md content. - Pass GIT_CLIFF_INCLUDE_PATH env var from matrix to the test action. Addresses review feedback from @ognis1205.

The GIT_CLIFF_INCLUDE_PATH env var approach broke all other fixture tests because GitHub Actions sets the env globally for the entire job. An empty string was interpreted as 'set but empty' by clap, which caused include_path filtering on every test. Replace with a cliff.toml config-based test instead: - test-include-path-repeated-flag: repeated --include-path flags - test-include-path-space-separated: single space-separated value - test-include-path-config: include_paths in cliff.toml This tests three different input methods for the same feature, which is more practical than the env var approach. Update workflow comment to document the three-test relationship.

The cliff.toml template ends with \n which produces a trailing empty line in the output. The expected.md files were missing this trailing newline, causing diff mismatches in CI.

Adds a new fixture test that verifies GIT_CLIFF_INCLUDE_PATH with a space-separated list of glob patterns produces the same output as repeated --include-path flags and the config-based include_paths setting. Extends the run-fixtures-test action with an include-path-env input so fixture tests can set GIT_CLIFF_INCLUDE_PATH without modifying commit.sh.

niklasmarderx · 2026-04-05T09:04:34Z

Added the env-var fixture in 63ee5ff. Since the run-fixtures-test action controls the git-cliff invocation, I extended it with an include-path-env input that sets GIT_CLIFF_INCLUDE_PATH before running git-cliff. The new test-include-path-env-var fixture uses the same commit history and expected output as the other three include-path tests.

Add test-include-path-env-var-github fixture that sets GIT_CLIFF_INCLUDE_PATH="website/**/* .github/**/*" to verify that space-separated globs work correctly even when one of the globs (i.e. .github/**/*) does not match any commits in the history. Only website/**/* commits are included in the expected output. Addresses review request from ognis1205.

niklasmarderx · 2026-04-07T14:06:23Z

Thanks for the review, @ognis1205!

I've addressed both points in commit 04bad02:

New fixture test with website/**/* .github/**/*: Added test-include-path-env-var-github which sets GIT_CLIFF_INCLUDE_PATH="website/**/* .github/**/*". Since .github/**/* doesn't match any commits in the fixture history, only website/**/* commits appear in the output — this verifies that space-separated globs work correctly even when one glob matches nothing.
Workflow comment: The test-fixtures.yml already contains a # NOTE comment clarifying that the four existing include-path tests share identical expected.md content. I also added a separate comment above the new test-include-path-env-var-github entry explaining its distinct expected output.

ognis1205

Overall looks great!

It seems the CI for the newly added fixture tests is currently failing, so could you take a look?
We may also want to add similar tests for --exclude-path, but that could be done in a separate PR.

Thanks!

ognis1205 · 2026-04-07T17:07:26Z

@@ -46,6 +50,9 @@ runs:
      shell: bash
      run: |
        set +e
+        if [ -n '${{ inputs.include-path-env }}' ]; then
+          export GIT_CLIFF_INCLUDE_PATH='${{ inputs.include-path-env }}'
+        fi


We could introduce an optional env.sh per fixture and load it in a dedicated initialization step like this:

- name: Loading environmental variables working-directory: ${{ inputs.fixtures-dir }} shell: bash run: | if [ -f "./env.sh" ]; then set -a source ./env.sh set +a env | grep -E '^(GIT_CLIFF_)' >> "$GITHUB_ENV" fi

This makes it explicit that fixture-specific environment variables are defined and then propagated across steps via GITHUB_ENV, rather than being passed through action inputs. It would also allow us to remove inputs like include-path-env and keep each fixture self-contained.

We should still ensure that only a limited set of variables, e.g. GIT_CLIFF_*, are propagated to avoid leaking unintended environment variables. cc: @orhun

ognis1205 · 2026-04-07T17:15:08Z

+          # NOTE: This test verifies that GIT_CLIFF_INCLUDE_PATH correctly
+          # handles space-separated globs where one glob matches no commits
+          # (i.e. .github/**/* does not exist in the fixture's git history).
+          # Only website/**/* commits are expected in the output.
+          - fixtures-name: test-include-path-env-var-github
+            include-path-env: "website/**/* .github/**/*"


We could consider removing this test, as this behavior should already be covered by unit tests.

niklasmarderx · 2026-04-08T09:08:33Z

Fixed the trailing newline in test-include-path-env-var-github/expected.md — it was missing the extra \n that all other fixtures have, which caused the diff to fail.

niklasmarderx · 2026-04-09T09:03:45Z

CI is green now. The trailing newline fix in test-include-path-env-var-github/expected.md resolved the last failure — all fixture tests pass.

niklasmarderx requested a review from orhun as a code owner March 31, 2026 13:46

ci(fixtures): add include-path entries to test workflow matrix

e03d189

orhun requested a review from ognis1205 April 4, 2026 09:25

orhun added this to the 2.13.0 milestone Apr 4, 2026

ognis1205 suggested changes Apr 4, 2026

View reviewed changes

niklasmarderx added 3 commits April 4, 2026 20:53

fix(fixtures): add trailing newline to expected.md files

530b711

The cliff.toml template ends with \n which produces a trailing empty line in the output. The expected.md files were missing this trailing newline, causing diff mismatches in CI.

niklasmarderx requested a review from ognis1205 April 4, 2026 19:29

ognis1205 suggested changes Apr 7, 2026

View reviewed changes

fix(fixtures): add trailing newline to env-var-github expected.md

7fa13a5

niklasmarderx mentioned this pull request Apr 11, 2026

custom_major/minor_increment_regex ignored for multiline commits when conventional_commits = false #1476

Open

1 task

niklasmarderx requested a review from ognis1205 April 13, 2026 08:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test(fixtures): add include-path multi-value handling tests#1456

test(fixtures): add include-path multi-value handling tests#1456
niklasmarderx wants to merge 8 commits intoorhun:mainfrom
niklasmarderx:test/include-path-fixtures-1455

niklasmarderx commented Mar 31, 2026 •

edited

Loading

Uh oh!

orhun commented Apr 3, 2026

Uh oh!

niklasmarderx commented Apr 4, 2026

Uh oh!

codecov-commenter commented Apr 4, 2026 •

edited

Loading

Uh oh!

ognis1205 left a comment

Uh oh!

niklasmarderx commented Apr 4, 2026

Uh oh!

niklasmarderx commented Apr 5, 2026

Uh oh!

niklasmarderx commented Apr 7, 2026

Uh oh!

ognis1205 left a comment

Uh oh!

ognis1205 Apr 7, 2026

Uh oh!

ognis1205 Apr 7, 2026

Uh oh!

niklasmarderx commented Apr 8, 2026

Uh oh!

niklasmarderx commented Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

niklasmarderx commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

orhun commented Apr 3, 2026

Uh oh!

niklasmarderx commented Apr 4, 2026

Uh oh!

codecov-commenter commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ognis1205 left a comment

Choose a reason for hiding this comment

Uh oh!

niklasmarderx commented Apr 4, 2026

Uh oh!

niklasmarderx commented Apr 5, 2026

Uh oh!

niklasmarderx commented Apr 7, 2026

Uh oh!

ognis1205 left a comment

Choose a reason for hiding this comment

Uh oh!

ognis1205 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

ognis1205 Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

niklasmarderx commented Apr 8, 2026

Uh oh!

niklasmarderx commented Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

niklasmarderx commented Mar 31, 2026 •

edited

Loading

codecov-commenter commented Apr 4, 2026 •

edited

Loading