Githooks là gì? Tìm hiểu cách sử dụng Githooks để ngăn chặn commit ẩu

Githooks là gì? Tìm hiểu cách sử dụng Githooks để ngăn chặn commit ẩu

Tin ngắn hàng ngày dành cho bạn
  • Mọi người có thấy Google đang hoạt động rất mạnh không? Họ cho ra mắt dồn dập các mô hình với chất lượng rất tốt. Mới đây là Gemma 3 QAT Models: Bringing state-of-the-Art AI to consumer GPUs. Đại khái là mang các mô hình chất lượng xuống chạy trong máy tính phổ thông.

    Hy vọng cuộc chuyển dịch này diễn ra nhanh nhanh để ai ai cũng được tiếp xúc với các mô hình mới nhất, mạnh mẽ nhất ngay trong máy tính của mình 🙏

    » Xem thêm
  • Vậy là mình đã đọc xong cuốn sách Búp sen xanh của nhà văn Sơn Tùng rồi mọi người ạ. Phải nói là quá suất sắc, đặc biệt là còn sắp vào dịp lễ trọng đại.

    Cách viết của tác giả rất gần gũi với tuổi thơ, tuy có một số từ tác giả dùng từ địa phương nhưng điều đó càng làm tăng thêm sự mộc mạc, chất phác. Mình đã bị cuốn vào câu chuyện từ những chương đầu tiên, về tuổi thơ, về gia đình, ngôi nhà và cả những chuyến hồi kinh đầy gian khổ. Càng đọc, càng thấy một khung cảnh sương mù ảm đảm, nhưng trái ngược với đó là ánh đèn le lói từ ngôi nhà của Bác, từ những người hoạt động cách mạng, không một bóng sương nào có thể khuất phục.

    Cuốn sách này cũng giúp mình trả lời câu hỏi tại sao Người lại quyết định ra đi tìm đường cứu nước ở Bến cảng nhà Rồng. Đó không phải là quyết định chớp nhoáng, thích là đi được mà là một cuộc hành trình dài trên con đường trưởng thành. Từ một cậu bé lễ phép, có phần tinh nghịch, tuổi thơ bất hạnh đến khi trở thành một cậu học sinh yêu nước, người thầy mẫu mực, cuối cùng là anh công nhân ở bến cảng.

    Thú thật là 2 tuần vừa rồi mình có nhiều việc phải làm những mỗi tối vẫn dành ít nhất 30 phút để đọc. Bình thường đọc được một lúc thì mắt sẽ mỏi, não ngưng hoạt động nhưng không hiểu sao đọc đến cuốn sách này thì lại càng tỉnh. Có hôm đến 2 giờ sáng rồi mới giật mình đi ngủ. Một tác phẩm kinh điển của văn học Việt Nam.

    » Xem thêm
  • Trong đợt khảo sát chừng 1 năm trước, mình có hỏi mọi người là có sẵn sàng bỏ tiền ra để mua gói cao cấp không, thì có đến 35% số người trả lời chắc nịch là "Không", 65% còn lại nằm trong nhóm có khả năng sẽ mua.

    Nếu bạn thường xuyên ghé vào blog thì nhiều khả năng đã thấy bài viết mới nhất màu vàng ngay đầu trang chủ. Khi bấm vào nó hiện ra một nút yêu cầu mở khoá để đọc bài viết. Điều đó có ý nghĩa gì? Đúng vậy, mình đang chuẩn bị cho quá trình bán gói cao cấp.

    Thời điểm mình đăng bài viết đó cách đây gần 9 ngày. Theo thống kê, số lượng người bấm vào để đọc là 20 lượt. Nếu so sánh nó với bài viết có nhiều lượt xem nhất cùng thời điểm là 60, còn số lượng truy cập vào trang chủ là 122. Tức là cứ mỗi 6 lượt ra trang chủ thì có một lượt bấm vào bài viết cao cấp.

    Quyết định bán gói cao cấp không phải bộc phát, đó là cả một quá trình. Hơn nữa là sự quan tâm của bạn đọc, những người thường xuyên ghé thăm trang web. Các bạn là những người biết rõ nhất lợi ích mà trang web mang lại và đóng góp một phần công sức vào sự phát triển. Còn mình thì vẫn luôn luôn nỗ lực để mang lại trải nghiệm tốt nhất cho độc giả của 2coffee.dev.

    Tại sao lại bán gói cao cấp? Mà bán thì ai mua? Sao không cứ mãi mãi phát triển như bây giờ đi? Được rồi, đó là những câu hỏi mà tôi tin rằng bất kỳ ai đọc đến đây đều phải thắc mắc.

    Việc bán gói cao cấp đánh dấu một sự phát triển mới của 2coffee.dev, cả cho mình và cả cho độc giả. Tại sao? Nếu mình vẫn tiếp tục ở vòng lặp đọc - viết - rồi lại đọc - viết thì đó là một vòng an toàn, chẳng có sự đổi mới, thậm chí còn giới hạn óc sáng tạo. Một tính năng mới, tham gia vào một lĩnh vực mới giúp phá vỡ vòng lặp này và đưa bản thân vào những thách thức mới hơn. Nếu thất bại, đó là một bài học đáng giá. Ngược lại, đó là nguồn động lực to lớn mà tin rằng không chỉ dành riêng cho mình. Độc giả giờ đây sẽ có thêm lựa chọn mới, trải nghiệm mới mà trước nay chưa hề có.

    Mình không sợ thất bại, ngược lại dám nghĩ dám làm và bài học rút ra mới là điều đáng trân quý.

    » Xem thêm

Vấn đề

Làm việc với git đã lâu nhưng có thể bạn chưa biết rằng trong git cũng có khái niệm hooks và họ gọi là githooks. Githooks được kích hoạt thông qua các sự kiện, từ đó giúp bạn có thể chèn thêm những công việc cần xử lý trước hoặc sau khi thực hiện hành động đó.

Githooks là gì?

Githooks là các script mà Git thực thi trước hoặc sau các sự kiện như: commit, push và receive. Githooks là một tính năng được tích hợp sẵn trong git nên chúng ta không cần tải xuống thêm bất cứ thứ gì.
Git cung cấp rất nhiều hooks, một số hooks phổ biến có thể kể đến là:

  • pre-commit: Được gọi khi dùng lệnh git commit và nó được chạy trước git commit
  • pre-receive: Đây là một hook được thực hiện ở phía server, được gọi trước khi git push.
  • post-commit: Được gọi sau khi dùng lệnh git commit. Hành vi trong post-commit không ảnh hưởng đến kết quả của commit vì nó được kích hoạt sau khi commit thành công.
  • post-receive: Đây là một hook được thực hiện ở phía server, được gọi sau khi dùng lệnh git push. Hành vi trong post-receive không ảnh hưởng đến kết quả của lệnh push vì nó được kích hoạt sau khi push thành công.

Để xem danh sách đầy đủ và mô tả của hooks bạn tham khảo thêm ở trang tài liệu git.

Mỗi kho lưu trữ Git đều có một thư mục .git/hooks có chứa các file tương ứng cho mỗi hook mà bạn muốn sử dụng. Bạn có thể thay đổi nội dung các file này và Git sẽ thực thi chúng khi những sự kiện đó xảy ra.

Các hooks trong git có thể được chia ra thành hai loại: Loại chạy phía máy khách (client-side) và loại chạy phía máy chủ (server-side). Các hooks phía máy khách được chạy trước hoặc sau hành động trên máy khách (local repository) còn các hooks máy chủ được chạy trước hoặc sau khi được đẩy tới server (remote repository).

Các hooks phía máy chủ được sử dụng để thực thi mạnh mẽ hơn các chính sách (policies) mà chúng ta muốn vì nó được được remote kiểm tra, bởi vì các hooks phía máy khách có thể dễ dàng bỏ qua bởi nhiều thủ thuật. Để biết những hook nào chạy ở phía máy khách hay chủ bạn có thể xem chi tiết trong tài liệu git.

Cách sử dụng Githooks

Khi dùng git init để khởi tạo git repository cho project thì git cũng tạo những tệp example của các hook trong thư mục .git/hooks các bạn có thể vào xem. Thực chất đây là những tập lệnh bash.

thư mục .git/hooks

Ví dụ đây là nội dung của file pre-commit.sample:

#!/bin/sh
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-commit".

if git rev-parse --verify HEAD >/dev/null 2>&1
then
  against=HEAD
else
  # Initial commit: diff against an empty tree object
  against=$(git hash-object -t tree /dev/null)
fi

# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --type=bool hooks.allownonascii)

# Redirect output to stderr.
exec 1>&2

# Cross platform projects tend to avoid non-ASCII filenames; prevent
# them from being added to the repository. We exploit the fact that the
# printable range starts at the space character and ends with tilde.
if [ "$allownonascii" != "true" ] &&
  # Note that the use of brackets around a tr range is ok here, (it's
  # even required, for portability to Solaris 10's /usr/bin/tr), since
  # the square bracket bytes happen to fall in the designated range.
  test $(git diff --cached --name-only --diff-filter=A -z $against |
    LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
then
  cat <<\EOF
Error: Attempt to add a non-ASCII file name.

This can cause problems if you want to work with people on other platforms.

To be portable it is advisable to rename the file.

If you know what you are doing you can disable this check using:

  git config hooks.allownonascii true
EOF
  exit 1
fi

# If there are whitespace errors, print the offending file names and fail.
exec git diff-index --check --cached $against --

Đối với hooks pre-commit, nếu bạn return một exit status khác 0 thì ngay lập tức commit sẽ bị huỷ bỏ và trả về lỗi. Để cấu hình sử dụng hook nào rất đơn giản chỉ cần đặt tên file là tên hooks trong thư mục .git/hooks (xoá đuôi .sample).

Sử dụng pre-commit để ngăn chặn commit ẩu

Commit ẩu có thể là những commit chưa chịu chạy qua ESLint để kiểm tra cú pháp hay chưa chạy Unit test trước đó. Tuỳ vào trường hợp của bạn mà sẽ có những lúc bạn muốn ngăn chặn những commit mà vi phạm một lỗi nào đó được quy định từ trước. Những lúc như thế thì áp dụng hooks pre-commit là quá chuẩn.

Ví dụ tôi muốn mỗi khi commit phải chạy qua Unit test, nếu thành công thì mới tiến hành commit còn không thì báo lỗi thì làm như sau.

Tạo file .git/hooks/pre-commit với nội dung:

#!/bin/sh
git stash -q --keep-index
npm run test
status=$?
git stash pop -q
exit $status

Trước khi run test tôi tiến hành stash các file trước đó vì những file đó không nằm trong commit, rồi sau đó unstash và trả về exit với status là exit status của lệnh npm run test. Cú pháp $? trong bash là lấy exit code của task cuối cùng. Trong trường hợp sử dụng khác bạn có thể thay đổi npm run test thành bất kì lệnh nào mà bạn muốn kiểm tra trước khi commit.

Tổng kết

Bên trên chỉ là một ví dụ nhỏ của việc sử dụng githook, ngoài pre-commit còn rất nhiều hook khác. Bằng cách kết hợp các hook sẽ giúp bạn giải quyết được điều vấn đề hơn nữa.

Tài liệu tham khảo:

Cao cấp
Hello

Bí mật ngăn xếp của Blog

Là một lập trình viên, bạn có tò mò về bí mật công nghệ hay những khoản nợ kỹ thuật về trang blog này? Tất cả bí mật sẽ được bật mí ngay bài viết dưới đây. Còn chờ đợi gì nữa, hãy bấm vào ngay!

Là một lập trình viên, bạn có tò mò về bí mật công nghệ hay những khoản nợ kỹ thuật về trang blog này? Tất cả bí mật sẽ được bật mí ngay bài viết dưới đây. Còn chờ đợi gì nữa, hãy bấm vào ngay!

Xem tất cả

Đăng ký nhận thông báo bài viết mới

hoặc
* Bản tin tổng hợp được gửi mỗi 1-2 tuần, huỷ bất cứ lúc nào.

Bình luận (1)

Nội dung bình luận...
Avatar
Jess Vanes2 năm trước
Cũng có thư viện giúp bạn làm việc dễ dàng hơn với hook của git nữa
Trả lời