{{ message }}
fix(check): expand env vars in rev_range arg - #1993
Open
ilitygergo wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates cz check --rev-range so pre-commit hook arguments containing environment variables can be resolved before Git commit validation runs.
Changes:
- Expands environment variables in the
rev_rangeargument. - Adds parameterized tests covering literal and
$VAR/${VAR}rev-range forms.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
commitizen/commands/check.py |
Expands rev_range values before validation. |
tests/commands/test_check_command.py |
Adds tests for env-var expansion in rev ranges. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| self.commit_msg = arguments.get("message") | ||
| self.rev_range = arguments.get("rev_range") | ||
| if self.rev_range is not None: | ||
| self.rev_range = os.path.expandvars(self.rev_range) |
There was a problem hiding this comment.
I suggest limiting the expansion to the two pre-commit ref variables to reduce the attack surface from arbitrary environment variable expansion in branch names, as discussed in the issues around the rev-range argument.
if self.rev_range is not None:
for var in ("PRE_COMMIT_FROM_REF", "PRE_COMMIT_TO_REF"):
value = os.environ.get(var)
if value is None:
continue
self.rev_range = self.rev_range.replace(f"${{{var}}}", value)
self.rev_range = self.rev_range.replace(f"${var}", value)
self.rev_range = self.rev_range.replace(f"%{var}%", value)
Comment on lines
+45
to
+46
| if self.rev_range is not None: | ||
| self.rev_range = os.path.expandvars(self.rev_range) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Checklist
Was generative AI tooling used to co-author this PR?
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
The
commitizen-branchpre-push hook should successfully validate commit messagesusing the ref range provided by pre-commit via the
PRE_COMMIT_FROM_REFandPRE_COMMIT_TO_REFenvironment variables.Steps to Test This Pull Request
.pre-commit-config.yaml:pre-commit install --hook-type pre-commit --hook-type commit-msg --hook-type pre-pushgit commit -m "feat: my new feature"git push— thecommitizen-branchhook should pass instead of failing with:fatal: ambiguous argument '$PRE_COMMIT_FROM_REF..$PRE_COMMIT_TO_REF': unknown revision or path not in the working treeEnvironment used for testing:
Additional Context
The root cause is that pre-commit passes
argsdirectly to the process as a listwithout shell interpolation, so
$PRE_COMMIT_FROM_REF..$PRE_COMMIT_TO_REFarrivesas a literal string to
cz checkrather than being expanded to actual git SHAs.Pre-commit does set these as environment variables in the hook process, so
os.path.expandvars()correctly resolves them at runtime.Closes #1923
Closes #1912
Related to #704