[Git] .gitignore 설정

1️⃣ 왜 필요할까?

Git으로 형상관리를 하면서 원격저장소에 Push하고 싶지 않은 불필요한 file들 존재

• EX) API KEY 값, log file, imi file, 로컬 개발 환경 setting에 관련된 file 등

.gitignore file로 목록을 작성해주면 Git 저장소로 Commit. Push 되지 않도록 해준

2️⃣ 기본적인 작성방법

• * 는 문자가 존재하지 않거나 한 개 이상이 있는 것을 의미

• ** 는 하위 폴더를 의미

  → 예를 들어 A/**/Z는 A/B/Z , A/B/C/Z , A/D/Z 등의 형태의 폴더들 탐색하게 된다.

• [] 는 중괄호 안의 한 글자를 의미

  → 예를 들어 [abc] : a 또는 b 또는 c 범위 지정 가능 → [0–9] : 0부터 9까지

• 표준 Glob Pattern을 사용

  → Shell에서 사용하는 간략화 된 정규 표현식

• / 부터 시작하는 경로 패턴은 하위 디텍토리 에서 반복적으로 적용하지 않음

• ! 로 시작하는 패턴은 gitignore에서 제외(무시되지 않음!)

• 공백 라인 또는 # 으로 시작하는 라인은 규칙 무시 (주석과 같은 의미)

3️⃣ gitignore 자동 생성 사이트

언어, 운영체제, IDE, 빌드 도구 정도를 추가

• 자동으로 gitignore 목록 생성해주는 사이트 - gitignore.io (opens new window)
• java, macos, gradle, intellij 추가 (opens new window)

# Created by https://www.gitignore.io/api/java,macos,gradle,intellij
# Edit at https://www.gitignore.io/?templates=java,macos,gradle,intellij

### Intellij ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn.  Uncomment if using
# auto-import.
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### Intellij Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# Sonarlint plugin
.idea/**/sonarlint/

# SonarQube Plugin
.idea/**/sonarIssues.xml

# Markdown Navigator plugin
.idea/**/markdown-navigator.xml
.idea/**/markdown-navigator/

### Java ###
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Gradle ###
.gradle
build/

# Ignore Gradle GUI config
gradle-app.setting

# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
!gradle-wrapper.jar

# Cache of project
.gradletasknamecache

# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
# gradle/wrapper/gradle-wrapper.properties

### Gradle Patch ###
**/build/

# End of https://www.gitignore.io/api/java,macos,gradle,intellij

Reference

• https://velog.io/@solar/.gitignore-파일-세팅 (opens new window)
• https://medium.com/@yeongpal/git-에-push-할-파일-예외처리하기-aec810a319e5 (opens new window)