René's URL Explorer Experiment

Title: fix(changelog): restore cwd-relative resolution for --file-name CLI arg by bearomorphism · Pull Request #1987 · commitizen-tools/commitizen · GitHub

Open Graph Title: fix(changelog): restore cwd-relative resolution for --file-name CLI arg by bearomorphism · Pull Request #1987 · commitizen-tools/commitizen

X Title: fix(changelog): restore cwd-relative resolution for --file-name CLI arg by bearomorphism · Pull Request #1987 · commitizen-tools/commitizen

Description: Description Why Fixes #1411 — relative paths work differently with newer versions. The user reported that after upgrading to v4.6.3, the following command stopped working as expected: # run from a Sphinx docs subdirectory cz -n cz_customize changelog --file-name=changelog/file Before v4.6.3: the file was created at /changelog/file (relative to the directory where cz was invoked — standard CLI behaviour). After v4.6.3: the file is created at /changelog/file (relative to the config file's directory), ignoring cwd. What changed Source Before v4.6.3 After v4.6.3 (broken) After this PR (fixed) --file-name CLI arg relative to cwd relative to config dir ❌ relative to cwd ✅ changelog_file config setting relative to cwd relative to config dir ✅ relative to config dir ✅ PR #1391 (v4.6.3) fixed a real bug — cz bump --changelog from a subdirectory was writing the changelog relative to the subdirectory instead of the project root. However, it applied the config-dir anchor to both sources: the config-file changelog_file setting AND the CLI --file-name argument. This over-correction broke existing setups that relied on --file-name being cwd-relative. How it works commitizen/commands/changelog.py: The __init__ method now distinguishes between the two sources: arguments.get("file_name") (CLI arg) → used as-is, relative to cwd config.settings.get("changelog_file") (config setting) → resolved relative to config.path.parent commitizen/commands/bump.py: When Bump invokes Changelog, it previously always forwarded file_name (even when the value came from config). It now only forwards file_name if it was explicitly provided via CLI (--file-name). Without a forwarded file_name, Changelog falls through to its own config lookup and applies the correct config-dir anchor. Backward compatibility Users who relied on --file-name being resolved relative to cwd: behaviour restored to pre-v4.6.3. Users who relied on changelog_file in config being resolved relative to the config dir: no change, the PR #1391 behaviour is preserved. Users who ran cz bump --changelog without --file-name from a subdirectory: no change, the changelog still goes to the project root (the PR #1391 fix is preserved). Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (GitHub Copilot CLI) Code Changes Add test cases to all the changes you introduce Run uv run poe all locally to ensure this change passes linter check and tests Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios Test edge cases and error conditions Ensure backward compatibility is maintained Update the documentation for the changes Expected Behavior cz changelog --file-name=changelog/CHANGES.md run from any working directory should write the changelog to /changelog/CHANGES.md. changelog_file = "CHANGELOG.md" in pyproject.toml should write the changelog to /CHANGELOG.md, regardless of the working directory. Steps to Test This Pull Request # Setup git init /tmp/test-cz && cd /tmp/test-cz git commit --allow-empty -m "feat: initial" cat > pyproject.toml << 'EOF' [tool.commitizen] version = "0.1.0" changelog_file = "CHANGELOG.md" EOF # 1. Verify: cz changelog --file-name from a subdir uses cwd mkdir -p subdir && cd subdir cz changelog --file-name=mychangelog.md --dry-run # Should show changelog content without creating /tmp/test-cz/mychangelog.md # 2. Verify: cz bump --changelog writes to project root even from subdir cd /tmp/test-cz/subdir git commit --allow-empty -m "feat: a feature" cz bump --changelog --dry-run # Changelog should go to /tmp/test-cz/CHANGELOG.md, NOT /tmp/test-cz/subdir/CHANGELOG.md Additional Context Introduced by PR #1391 ("fix: cz bump subdir"), merged 2025-05-07 into v4.6.3 Original issue: #1411

Open Graph Description: Description Why Fixes #1411 — relative paths work differently with newer versions. The user reported that after upgrading to v4.6.3, the following command stopped working as expected: # run from a ...

X Description: Description Why Fixes #1411 — relative paths work differently with newer versions. The user reported that after upgrading to v4.6.3, the following command stopped working as expected: # run from a ...

Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1987

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width