HelpersTask622_gitleaks_doesnt_run_in_submodules_2 #664
Conversation
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
Pre-commit checks: - 'check_master' passed - 'check_author' passed - 'check_file_size' passed - 'check_python_compile' passed - 'check_gitleaks' passed All checks passed ✅
Pre-commit checks: - 'check_master' passed - 'check_author' passed - 'check_file_size' passed - 'check_python_compile' passed - 'check_gitleaks' passed All checks passed ✅
Pre-commit checks: - 'check_master' passed - 'check_author' passed - 'check_file_size' passed - 'check_python_compile' passed - 'check_gitleaks' passed All checks passed ✅
Pre-commit checks: - 'check_master' passed - 'check_author' passed - 'check_file_size' passed - 'check_python_compile' passed - 'check_gitleaks' passed All checks passed ✅
…github.com:causify-ai/helpers into HelpersTask622_gitleaks_doesnt_run_in_submodules_2 Pre-commit checks: - 'check_master' passed - 'check_author' passed - 'check_file_size' passed - 'check_python_compile' passed - 'check_gitleaks' passed All checks passed ✅
heanhsok
commented
May 5, 2025
| git_root_dir = get_git_root_dir() | ||
| # Find relative path from the git root to the helpers root. | ||
| git_root_dir = hgit.find_git_root() | ||
| helpers_root_dir = hgit.find_helpers_root() |
There was a problem hiding this comment.
- I realize we'll be copying a lot of code from hgit for these two functions
- Since Git hooks are now installed and run after our thin client is activated, should we consider using the helpers module?
- This script is already somewhat coupled to the helpers, especially with the introduction of the gitleaks config path in dev_script_XYZ dir
- To keep things decoupled, we can also just copy all the functions needed (although a lot of codes) as well
WDYT? @gpsaggese
There was a problem hiding this comment.
Agree. Let's just import helpers and embrace it that a piece of the infra checking on the code depends on the code itself.
In an ideal world the git hooks should be a prod container (like the linter), but it is too paranoid
There was a problem hiding this comment.
Pull Request Overview
This PR moves the gitleaks configuration from the .github directory into dev_scripts_helpers/git/gitleaks so that it can be referenced by both GitHub Actions and git hooks without relying on symlinks.
- Refactored the check_gitleaks function in utils.py to compute repository paths using the new hgit helpers.
- Updated the GitHub Actions workflow to point to the new gitleaks configuration file path.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| dev_scripts_helpers/git/git_hooks/utils.py | Removed get_git_root_dir and updated check_gitleaks to compute and use the new config path |
| .github/workflows/gitleaks.yml | Updated GITLEAKS_CONFIG to reference the new location of the gitleaks configuration file |
Comments suppressed due to low confidence (1)
dev_scripts_helpers/git/git_hooks/utils.py:482
- [nitpick] Consider adding an inline comment to explain the rationale behind concatenating '/app' with the relative helpers root to form the config path, which would help future maintainers understand the docker mount configuration.
config_path = os.path.join("/app", rel_path, "dev_scripts_helpers/git/gitleaks")
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.
Task #622
.githubtodev_scripts_helpers/git/gitleaksso it can be pointed to from both the GH actions and the git hooks without creating symlinks