Đánh dấu tập tin là không phổ biến trên mạng với Git

Tôi muốn thể hiện một số công việc của mình bằng cách tải chúng lên tài khoản GitHub của tôi. Tuy nhiên, có một số tệp chứa mật khẩu, như kết nối cơ sở dữ liệu.

Có cách nào đánh dấu một tệp là không phù hợp với Git để nó không thể xuất hiện trên GitHub không?

Có cách nào đánh dấu một tệp là không phù hợp với Git để nó không thể xuất hiện trên GitHub không?

Đầu tiên, không có cách nào để có một số tệp và cam kết hiển thị trong kho Git cục bộ của bạn nhưng bằng cách nào đó không thể xem được trong GitHub; nếu bạn có một tệp được cam kết trong Git, nó sẽ hiển thị trong GitHub.

Thứ hai, không có cách nào đơn giản và thực tế để tự đánh dấu một tệp riêng lẻ là không phổ biến. Nhưng Nhưng chắc chắn có một cách để bỏ qua một tệp trong repo Git: Bằng cách thêm (các) tệp vào trong đường dẫn tương đối của chúng nếu cần thiết cho một .gitignoretập tin :

Một .gitignoretệp chỉ định các tệp không được theo dõi có chủ ý mà Git nên bỏ qua. Các tệp đã được theo dõi bởi Git không bị ảnh hưởng; xem các ghi chú bên dưới để biết chi tiết.

Tạo một cơ bản .gitignorelà khá dễ dàng vì nó chỉ là một tệp văn bản đơn giản. Vì vậy, ví dụ, nếu tôi có một config.phptập tin trong thư mục gốc, bạn sẽ làm điều này; giả sử bạn đang sử dụng PHP nhưng khái niệm này áp dụng cho mọi thiết lập. Ngoài ra, tôi đang sử dụng Nano làm trình soạn thảo văn bản của mình trong ví dụ này nhưng vui lòng sử dụng bất kỳ trình soạn thảo văn bản nào bạn thường sử dụng cho việc này:

nano .gitignore

Và chỉ cần thêm tên tệp đó vào tập tin đó:

config.php

Lưu nó và bây giờ Git sẽ đơn giản bỏ qua tập tin đó.

Điều đó nói rằng, những gì tôi muốn làm cho các thiết lập như thế này là giữ một cấu hình mẫu / ví dụ được đặt ở giữa các chi tiết nhạy cảm trong kho lưu trữ để tôi có một số tài liệu tham khảo về định dạng tệp cấu hình là một tệp có tên như thế này:

config.SAMPLE.php

Bằng cách đó, bạn biết chính xác cách config.phptệp sẽ được thiết lập thông qua config.SAMPLE.phpvà bạn có thể đảm bảo rằng thực tế config.phpkhông bao giờ bị Git chạm vào.

Ngoài ra, nếu bạn có kế hoạch hiển thị mã của mình, bạn cần phải hy vọng rằng ai đó sẽ cố gắng lấy mã đó và thực hiện nó trên hệ thống của riêng họ theo một cách nào đó. Hãy nhớ rằng, chúng tôi không phải là bạn và không có tệp cấu hình mẫu trong repo của bạn, mọi người sẽ không thực sự hiểu cách tự thực hiện mã. Họ thậm chí có thể nghĩ rằng bạn không đủ năng lực vì bạn không cung cấp một ví dụ cấu hình cơ bản.

Bạn cũng có thể thêm một hook hook trước để thực hiện kiểm tra độ tỉnh táo. Thư mục .git/hookscủa mỗi kho git có một số tập lệnh mẫu.

Tập lệnh được gọi pre-commitđược thực thi nếu nó tồn tại trước mỗi lần xác nhận và giá trị trả về khác không hủy bỏ cam kết.

Ví dụ: bạn có thể có một tập lệnh đơn giản như thế này:

#! /bin/sh -e
git ls-files --cached | grep -qx 'filename' && { echo "Excluded file included in the commit" >&2; exit 1; }
exit 0

Và nếu điều đó filenamephù hợp, cam kết thất bại.

Những gì @JakeGould nói. Trong một số trường hợp, bạn cũng có thể sử dụng các bit tệp đặc biệt như skip-worktreehoặc assume-unchangedcó thể được đặt theo cách sau; để biết sự khác biệt giữa hai loại này, hãy xem câu trả lời Stack Overflow này :

git update-index --assume-unchanged <file>

Sau đó sẽ ẩn các thay đổi bổ sung cho một tệp đã có và bạn có thể sử dụng nếu bạn thực sự muốn có một tệp ở đó sau mỗi lần kéo. Nhưng tôi sẽ khuyên bạn chỉ sử dụng nó nếu bạn thực sự biết những gì bạn đang làm.

Sử dụng .gitignorenhư @JakeGould nói. Ngoài ra, một số thông tin liên quan:

• .gitignoregiữ cho các tập tin khỏi bị theo dõi; nếu chúng đã được theo dõi sử dụng git rm --cachedđể loại bỏ chúng
• tập tin / mẫu trong $GIT_DIR/info/excludecũng sẽ bị bỏ qua
• các tệp / mẫu trong tệp được chỉ định bởi core.excludesFile trong người dùng ~/.gitconfigcũng bị bỏ qua.

Xem tài liệu chính thức của Git để biết thêm chi tiết.

Để mở rộng câu trả lời của Jake và 46: một cách rất hay là có một tiện ích mở rộng nhất quán bạn sử dụng cho các tệp bạn bao gồm thông tin cá nhân và sử dụng .gitignoređể luôn loại trừ các tệp có tiện ích mở rộng đó trên toàn cầu (sử dụng .gitconfigtệp như được đề cập ở nơi khác để luôn bị bỏ qua cho người dùng của bạn).

Bằng cách đó, bạn có thể có ví dụ:

/projectname/mypasswords.exc 

và nếu bạn đã loại trừ *.exctrên toàn cầu, thì bạn biết rằng nó sẽ không được cam kết, ngay cả khi bạn quên loại trừ riêng lẻ tệp cụ thể đó.