Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve hooks type annotation and fix missing link #1345

Merged
merged 2 commits into from
Feb 8, 2025
Merged

Improve hooks type annotation and fix missing link #1345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4573b38
style(hooks): improve type annotation
Lee-W Jan 30, 2025
79065bd
docs(hooks): fix missing link
Lee-W Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tutorials/auto_prepare_commit_message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ commitizen and use the generated commit message for the commit.

## Installation

Copy the hooks from [here](https://github.com/commitizen-tools/hooks) into the `.git/hooks` folder and make them
Copy the hooks from [here](https://github.com/commitizen-tools/commitizen/tree/master/hooks) into the `.git/hooks` folder and make them
executable by running the following commands from the root of your Git repository:

```bash
Expand Down
5 changes: 3 additions & 2 deletions hooks/post-commit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
exit(1)


def post_commit():
def post_commit() -> None:
backup_file = Path(get_backup_file_path())

# remove backup file if it exists
Expand All @@ -17,4 +17,5 @@ def post_commit():


if __name__ == "__main__":
exit(post_commit())
post_commit()
exit(0)
26 changes: 12 additions & 14 deletions hooks/prepare-commit-msg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,19 @@
exit(1)


def prepare_commit_msg(commit_msg_file: Path) -> int:
def prepare_commit_msg(commit_msg_file: str) -> int:
# check if the commit message needs to be generated using commitizen
if (
subprocess.run(
[
"cz",
"check",
"--commit-msg-file",
commit_msg_file,
],
capture_output=True,
).returncode
!= 0
):
exit_code = subprocess.run(
[
"cz",
"check",
"--commit-msg-file",
commit_msg_file,
],
capture_output=True,
).returncode
if exit_code != 0:
backup_file = Path(get_backup_file_path())

if backup_file.is_file():
# confirm if commit message from backup file should be reused
answer = input("retry with previous message? [y/N]: ")
Expand All @@ -54,6 +51,7 @@ def prepare_commit_msg(commit_msg_file: Path) -> int:

# write message to backup file
shutil.copyfile(commit_msg_file, backup_file)
return 0


if __name__ == "__main__":
Expand Down
Loading