Kiểm soát phiên bản là một công cụ quan trọng để theo dõi các thay đổi đối với cơ sở mã của bạn, nhưng không phải lúc nào bạn cũng muốn theo dõi mọi tệp.
Để tránh lộn xộn và giảm nguy cơ phân phối thông tin nhạy cảm, bạn có thể sử dụng tệp có tên .gitignore. Tệp này chỉ định tệp và thư mục nào Git không nên lập chỉ mục.
Việc xác định tệp nào sẽ được đưa vào .gitignore có thể là một thách thức, đặc biệt nếu bạn là người mới phát triển. Tìm hiểu những tệp bạn nên thêm vào .gitignore của mình để có quy trình làm việc Git mượt mà hơn.
Tạo tệp .gitignore
Để tệp .gitignore của bạn có hiệu lực, bạn phải khởi chạy Git trong dự án của mình.
Bạn có thể khởi tạo Git bằng cách chạy lệnh bên dưới trong thiết bị đầu cuối của mình:
git init
Lệnh này tạo một kho lưu trữ Git mới cho dự án của bạn, trong một thư mục con “.git” ẩn chứa tất cả các tệp và thư mục mà nó cần để kiểm soát phiên bản dự án của bạn.
Tiếp theo, tạo tệp .gitignore của bạn bằng cách chạy lệnh bên dưới:
touch .gitignore
Chạy lệnh trên sẽ tạo một tệp mới, “.gitignore” trong thư mục hiện tại của bạn. Bạn có thể loại trừ tệp khỏi Git bằng cách thêm tên tệp hoặc đường dẫn tệp (nếu tệp nằm trong thư mục khác với thư mục .gitignore tài liệu).
Git không cần theo dõi mọi tệp trong dự án của bạn và việc theo dõi một số tệp có thể dẫn đến các vấn đề không lường trước được. Đây là một số tệp bạn nên thêm vào .gitignore của mình.
1. Tệp cấu hình
Tệp cấu hình lưu trữ cài đặt và các tham số khác mà ứng dụng của bạn sử dụng để xác định và tùy chỉnh hành vi của chúng. Các tệp này thường lưu trữ các chuỗi kết nối cơ sở dữ liệu, khóa API và các thông tin nhạy cảm khác mà bạn không nên để lộ trong kho lưu trữ Git của mình.
Nếu bạn bao gồm các tệp cấu hình trong kho lưu trữ của mình, thì bất kỳ ai có thể truy cập vào kho lưu trữ đó đều có thể xem nội dung của chúng. Điều đó có thể bao gồm thông tin nhạy cảm, có thể dẫn đến vi phạm an ninh và các vấn đề khác.
Để loại trừ các tệp cấu hình khỏi kho lưu trữ Git của bạn, hãy thêm tên tệp hoặc tên thư mục cụ thể vào .gitignore tài liệu.
Ví dụ: bạn có thể thêm dòng bên dưới vào .gitignore tập tin để bỏ qua một .env tài liệu.
.env
2. Xây dựng cổ vật
Tạo tác phẩm là các tệp được biên dịch hoặc tạo ra khi bạn xây dựng dự án của mình. Các tệp này thường nằm trong một “mục tiêu” hoặc “xây dựng” danh mục.
Các tạo phẩm xây dựng có thể bao gồm các lớp Java đã biên dịch, tệp JAR, tệp WAR, tệp nhị phân, gói phân phối, báo cáo, tệp nhật ký và các tệp khác được tạo trong quá trình xây dựng.
Nói chung, đó là một phương pháp hay để loại trừ các tạo phẩm xây dựng khỏi kho lưu trữ Git của bạn vì chúng có thể rất lớn. Chúng cũng có thể ít di động hơn các tệp nguồn của bạn, chỉ liên quan đến một môi trường cụ thể. Việc đưa chúng vào kho lưu trữ của bạn có thể làm tăng kích thước kho lưu trữ của bạn và làm cho việc sao chép và làm việc với nó chậm hơn.
Để loại trừ các tạo phẩm xây dựng khỏi kho lưu trữ Git của bạn, hãy thêm “mục tiêu/” hoặc “xây dựng/” thư mục của bạn .gitignore tài liệu.
Ví dụ:
target/
build/
3. Tệp môi trường phát triển tích hợp
Các tệp Môi trường phát triển tích hợp (IDE) là các tệp cấu hình, siêu dữ liệu dự án và các tệp khác do IDE của bạn tạo khi bạn tạo hoặc mở một dự án. Các tệp này dành riêng cho từng IDE. IDE của bạn sử dụng các tệp này để định cấu hình cài đặt dự án.
Các tệp này không cần thiết để xây dựng hoặc chạy ứng dụng của bạn và thường có thể gây ra sự cố nếu được cam kết với kho lưu trữ Git được chia sẻ. Ví dụ: những người khác nhau trong nhóm của bạn có thể sử dụng các IDE hoặc phiên bản khác nhau và việc cam kết các tệp dành riêng cho IDE có thể gây ra xung đột hợp nhất và gây khó khăn cho việc cộng tác trong dự án.
Vì các tệp này dành riêng cho IDE nên các tệp cần đưa vào .gitignore tệp sẽ phụ thuộc vào IDE của bạn. Dưới đây là các đề xuất .gitignore của GitHub cho một số IDE phổ biến. Bạn có thể tìm kiếm IDE bạn chọn và thêm các tệp được phác thảo vào .gitignore tài liệu.
4. Tệp phụ thuộc và gói
Các tệp phụ thuộc và tệp gói là các tệp chứa thông tin về các tệp phụ thuộc và gói được ứng dụng của bạn sử dụng. Các công cụ xây dựng khác nhau, chẳng hạn như Trình quản lý gói nút (npm), tạo các tệp này.
Ví dụ: nếu bạn sử dụng npm để quản lý các phụ thuộc cho một dự án JavaScript, nó sẽ tạo một “nút_mô-đun” trong thư mục gốc của dự án. Thư mục chứa tất cả các phụ thuộc đã cài đặt cho dự án của bạn.
Thư mục này có thể trở nên rất lớn, đặc biệt nếu dự án của bạn có nhiều phần phụ thuộc hoặc một số phần phụ thuộc có kích thước tệp lớn. Bằng cách loại trừ “nút_mô-đun” từ kho lưu trữ Git của bạn, bạn có thể giữ cho nó sạch sẽ và giảm kích thước của nó.
Để tránh thêm dấu “nút_mô-đun” vào kho lưu trữ Git của bạn, hãy thêm tên của nó vào tệp .gitignore của bạn:
node_modules/
5. Tập tin hệ điều hành
Hệ điều hành của bạn và các công cụ hệ thống khác có thể tạo tệp thông qua sử dụng thông thường. Chúng có thể bao gồm tệp nhật ký, tệp tạm thời và tệp cấu hình hệ thống. Một ví dụ là Thumbs.db tệp trên Windows và tương đương với macOS của nó, tệp .DS_Store tài liệu.
Nói chung, nên loại trừ các tệp hệ điều hành khỏi kho lưu trữ Git của bạn, vì chúng dành riêng cho môi trường cục bộ của bạn và có thể khác nhau giữa các máy tính và hệ điều hành khác nhau.
GitHub đã đề xuất hướng dẫn .gitignore cho Windows, macOS và Linux.
Tầm quan trọng của kiểm soát phiên bản
Sử dụng kiểm soát phiên bản có thể cải thiện đáng kể quy trình làm việc của bạn, đồng thời giảm lỗi và xung đột có thể phát sinh khi làm việc trên cơ sở mã. Với kiểm soát phiên bản, bạn có thể dễ dàng theo dõi các thay đổi mã, xem lại chúng và cộng tác với các thành viên trong nhóm một cách liền mạch.
Tuy nhiên, bạn phải luôn loại trừ một số tệp nhất định, chẳng hạn như tệp cấu hình, tệp IDE và tệp OS. Điều này sẽ giảm kích thước kho lưu trữ của bạn và đảm bảo bạn không bị rò rỉ thông tin nhạy cảm.
