5 Jenis File untuk Dimasukkan ke dalam .gitignore
Table of content:
Kontrol versi adalah alat vital untuk melacak perubahan pada basis kode Anda, tetapi Anda tidak selalu ingin melacak setiap file.
Untuk menghindari kekacauan dan mengurangi risiko penyebaran nformasi sensitif, Anda dapat menggunakan file bernama .gitignore. File ini menentukan file dan direktori mana yang tidak boleh diindeks oleh Git.
Menentukan file mana yang akan disertakan dalam .gitignore bisa menjadi suatu tantangan, terutama jika Anda baru dalam pengembangan. Cari tahu file mana yang harus Anda tambahkan ke .gitignore Anda untuk alur kerja Git yang lebih lancar.
Membuat File .gitignore
Agar file .gitignore Anda memiliki efek, Anda harus menginisialisasi Git dalam proyek Anda.
Anda dapat menginisialisasi Git dengan menjalankan perintah di bawah ini di terminal Anda:
git init
Perintah ini membuat repositori Git baru untuk proyek Anda, di subdirektori “.git” tersembunyi yang berisi semua file dan direktori yang diperlukan untuk mengontrol versi proyek Anda.
Selanjutnya, buat file .gitignore Anda dengan menjalankan perintah di bawah ini:
touch .gitignore
Menjalankan perintah di atas membuat file baru, “.gitignore” di direktori Anda saat ini. Anda dapat mengecualikan file dari Git dengan menambahkan nama file atau jalur file (jika file berada di direktori yang berbeda dari .gitignore mengajukan).
Git tidak perlu melacak setiap file dalam proyek Anda, dan melacak beberapa file dapat menyebabkan masalah yang tidak terduga. Ini adalah beberapa file yang harus Anda tambahkan ke .gitignore Anda.
1. File Konfigurasi
File konfigurasi menyimpan pengaturan dan parameter lain yang digunakan aplikasi Anda untuk menentukan dan menyesuaikan perilakunya. File-file ini sering menyimpan string koneksi database, kunci API, dan informasi sensitif lainnya yang tidak boleh Anda tampilkan di repositori Git Anda.
Jika Anda menyertakan file konfigurasi di repositori Anda, siapa pun yang dapat mengaksesnya dapat melihat isinya. Itu mungkin termasuk informasi sensitif, yang dapat menyebabkan pelanggaran keamanan dan masalah lainnya.
Untuk mengecualikan file konfigurasi dari repositori Git Anda, tambahkan nama file atau nama folder tertentu ke file .gitignore mengajukan.
Misalnya, Anda dapat menambahkan baris di bawah ini ke file Anda .gitignore file untuk mengabaikan a .env mengajukan.
.env
2. Bangun Artefak
Artefak build adalah file yang dikompilasi atau dihasilkan yang dihasilkan saat Anda membangun proyek. File-file ini biasanya tinggal di a “target” atau “membangun” direktori.
Artefak build dapat menyertakan kelas Java yang dikompilasi, file JAR, file WAR, file biner, paket distribusi, laporan, file log, dan lainnya yang dihasilkan selama proses build.
Biasanya merupakan praktik yang baik untuk mengecualikan artefak build dari repositori Git Anda karena ukurannya bisa sangat besar. Mereka mungkin juga kurang portabel daripada file sumber Anda, hanya relevan untuk lingkungan tertentu. Memasukkan mereka ke dalam repositori Anda dapat menggembungkan ukuran repositori Anda dan membuatnya lebih lambat untuk dikloning dan bekerja dengannya.
Untuk mengecualikan artefak bangunan dari repositori Git Anda, tambahkan “target/” atau “membangun/” direktori ke Anda .gitignore mengajukan.
Misalnya:
target/
build/
3. File Lingkungan Pengembangan Terintegrasi
File Integrated Development Environment (IDE) adalah file konfigurasi, metadata proyek, dan file lain yang dihasilkan oleh IDE Anda saat Anda membuat atau membuka proyek. File-file ini khusus untuk setiap IDE. IDE Anda menggunakan file-file ini untuk mengonfigurasi pengaturan proyek.
File-file ini tidak diperlukan untuk membangun atau menjalankan aplikasi Anda dan seringkali dapat menyebabkan masalah jika dikomit ke repositori Git bersama. Misalnya, orang yang berbeda di tim Anda mungkin menggunakan IDE atau versi yang berbeda, dan memasukkan file khusus IDE dapat menyebabkan konflik penggabungan dan mempersulit kolaborasi dalam proyek.
Karena file-file ini khusus untuk IDE, file-file yang akan disertakan dalam file .gitignore file akan tergantung pada IDE Anda. Di sini adalah Rekomendasi .gitignore GitHub untuk beberapa IDE populer. Anda dapat mencari IDE pilihan Anda dan menambahkan file yang diuraikan ke file Anda .gitignore mengajukan.
4. File Ketergantungan dan Paket
File dependensi dan paket adalah file yang berisi informasi tentang dependensi dan paket yang digunakan oleh aplikasi Anda. Berbagai alat build, seperti Node Package Manager (npm), menghasilkan file-file ini.
Misalnya, jika Anda menggunakan npm untuk mengelola dependensi untuk proyek JavaScript, itu akan membuat “node_modules” di direktori root proyek Anda. Direktori ini berisi semua dependensi yang diinstal untuk proyek Anda.
Direktori ini bisa menjadi sangat besar, terutama jika proyek Anda memiliki banyak dependensi atau beberapa dependensi memiliki ukuran file yang besar. Dengan mengecualikan “node_modules” dari repositori Git Anda, Anda dapat menjaganya tetap bersih dan mengurangi ukurannya.
Untuk menghindari menambahkan “node_modules” ke repositori Git Anda, tambahkan namanya ke file .gitignore Anda:
node_modules/
5. File Sistem Operasi
Sistem operasi Anda, dan alat sistem lainnya, dapat menghasilkan file melalui penggunaan normal. Ini mungkin termasuk file log, file sementara, dan file konfigurasi sistem. Contohnya adalah Jempol.db file di Windows dan setara macOS-nya, file .DS_Store mengajukan.
Biasanya merupakan praktik yang baik untuk mengecualikan file sistem operasi dari repositori Git Anda, karena file tersebut khusus untuk lingkungan lokal Anda dan dapat berbeda antara komputer dan sistem operasi yang berbeda.
GitHub telah merekomendasikan panduan .gitignore untuk Windows, macOSDan Linux.
Pentingnya Kontrol Versi
Menggunakan kontrol versi dapat meningkatkan alur kerja Anda secara signifikan dan mengurangi kesalahan dan konflik yang mungkin muncul saat mengerjakan basis kode. Dengan kontrol versi, Anda dapat dengan mudah melacak perubahan kode, meninjaunya, dan berkolaborasi dengan anggota tim secara lancar.
Namun, Anda harus selalu mengecualikan file tertentu, seperti file konfigurasi, file IDE, dan file OS. Ini akan menjaga ukuran repositori Anda tetap rendah dan memastikan Anda tidak membocorkan informasi sensitif.