Bắt đầu một tin nhắn cam kết git với một dấu băm (#)

Git coi các dòng bắt đầu bằng #các dòng nhận xét khi cam kết. Điều này rất khó chịu khi làm việc với hệ thống theo dõi vé và cố gắng viết số vé ở đầu dòng, ví dụ:

#123 salt hashed passwords

git sẽ chỉ xóa dòng khỏi thông điệp cam kết. Có cách nào để thoát khỏi hàm băm không? tôi đã thử \và !, nhưng không có gì hoạt động. khoảng trắng trước đây #được bảo tồn, vì vậy chúng cũng không phải là giải pháp hiệu quả cho vấn đề.

Hành vi này là một phần của hành vi git commit'dọn dẹp' mặc định. Nếu bạn muốn giữ các dòng bắt đầu với #bạn có thể sử dụng chế độ dọn dẹp thay thế.

Ví dụ

git commit --cleanup=whitespace

Nếu bạn làm điều này, bạn phải cẩn thận để xóa tất cả các #dòng mà bạn không muốn xuất hiện trong cam kết.

Lưu ý rằng, kể từ git1.8.2 (tháng 2 năm 2013) , bạn có thể sử dụng một ký tự khác với ' #' cho dòng nhận xét trong thông báo cam kết.

Điều đó cho phép bạn sử dụng ' #' để tham khảo số lỗi của bạn.

Các dòng "gợi ý" khác nhau mà Git đưa ra khi nó yêu cầu người dùng chỉnh sửa tin nhắn trong trình chỉnh sửa được nhận xét bằng ' #' theo mặc định.

Biến core.commentCharcấu hình có thể được sử dụng để tùy chỉnh ' #' này thành một ký tự khác.

Về lý thuyết, bạn có thể đặt một core.commentChartừ (nhiều ký tự), nhưng git 2.0.x / 2.1 sẽ chặt chẽ hơn (quý 3 năm 2014).

Xem cam kết 50b54fd của Nguyễn Thái Ngọc Duy ( pclouds) :

cấu hình: nghiêm ngặt trên core.commentChar

Chúng tôi không hỗ trợ các chuỗi nhận xét (ít nhất là chưa). Và mã hóa ký tự nhiều byte cũng có thể bị hiểu sai.

Bài kiểm tra với hai dấu phẩy được cập nhật vì nó vi phạm điều này. Nó được thêm vào với bản vá giới thiệu core.commentChartrong eff80a9 (Cho phép tùy chỉnh "bình luận char" - 2013-01-16). Tôi không rõ tại sao hành vi đó lại muốn.

git 2.0.x / 2.1 (quý 3 năm 2014) sẽ thêm lựa chọn tự động cho core.commentChar:
Xem cam kết 84c9dc2

Khi core.commentCharlà " auto", char bình luận bắt đầu bằng ' #' như mặc định nhưng nếu nó đã có trong thông báo đã chuẩn bị, hãy tìm một char khác trong một tập hợp nhỏ. Điều này sẽ dừng bất ngờ vì git dải một số dòng bất ngờ.

Lưu ý rằng git không đủ thông minh để nhận ra ' #' là char bình luận trong các mẫu tùy chỉnh và chuyển đổi nó nếu char bình luận cuối cùng khác.
Nó nghĩ các dòng '#' trong các mẫu tùy chỉnh như là một phần của thông điệp cam kết. Vì vậy, không sử dụng điều này với các mẫu tùy chỉnh.

Danh sách các nhân vật ứng cử viên cho "tự động" là:

# ; @ ! $ % ^ & | :

Điều đó có nghĩa là một lệnh like git commit -m '#1 fixed issue'sẽ tự động chuyển bình luậnChar thành ' ;', vì ' #' đã được sử dụng trong thông báo cam kết.

Câu trả lời ở đây là tốt và chi tiết, nhưng đối với một git noob như tôi tùy chỉnh các tùy chọn cấu hình git không quá rõ ràng. Dưới đây là một ví dụ để thay đổi từ #thành ;cho các ký tự nhận xét:

git config core.commentChar ";"

Đó là tất cả những gì bạn cần làm.

Bạn có thể sử dụng tùy chọn dòng lệnh -m:

git commit -m "#123 fixed"

Nếu bạn đang thực hiện một cuộc nổi loạn tương tác, thì khi bạn lưu thông điệp cam kết của mình mà không có gì trong đó (vì #ngay từ đầu đã đưa ra nhận xét và do đó nó bị bỏ qua) git sẽ cho bạn biết phải làm gì:

Aborting commit due to empty commit message.
Could not amend commit after successfully picking 5e9159d9ce3a5c3c87a4fb7932fda4e53c7891db... 123 salt hashed passwords
This is most likely due to an empty commit message, or the pre-commit hook
failed. If the pre-commit hook failed, you may need to resolve the issue before
you are able to reword the commit.
You can amend the commit now, with

        git commit --amend

Once you are satisfied with your changes, run

        git rebase --continue

Vì vậy, chỉ cần sửa đổi thông báo:

git commit --amend -m "#123 salt hashed passwords"

và tiếp tục cuộc nổi loạn:

git rebase --continue

git commit --cleanup=scissorsnên được sử dụng. Nó được thêm vào Git v2.0.0 vào ngày 2014.05.21

từ git commit --help

--cleanup=<mode>
  scissors
    Same as whitespace, except that everything from (and including) the line
    "# ------------------------ >8 ------------------------" is truncated if the message
    is to be edited. "#" can be customized with core.commentChar.

Sử dụng một tiền tố khác nhau cho số vé. Hoặc thêm một từ vào số vé, như "Lỗi # 42". Hoặc thêm một ký tự khoảng trắng vào dòng; nếu bạn muốn xóa khoảng trắng đó, bạn có thể thêm hook-hook cho điều đó.

Cá nhân tôi thà không thực hiện thao tác cam kết thông điệp cam kết này bởi một cái móc bởi vì nó có thể rất khó chịu khi nó kích hoạt khi bạn không muốn nó. Giải pháp đơn giản nhất có lẽ là suy nghĩ lại vấn đề.

Tất cả các cam kết của tôi bắt đầu với #issueNumbervì vậy tôi đặt bản tóm tắt này cho vim .git/hooks/commit-msg:

NAME=$(git branch | grep '*' | sed 's/* //') 
echo "$NAME"' '$(cat "$1") > "$1"

Vì vậy, giả sử chúng tôi có chi nhánh #15và chúng tôi thực hiện thông điệp cam kết add new awesome feature. Với cách tiếp cận này, thông điệp cam kết cuối cùng sẽ được #15 add new awesome feature.