본문 바로가기
코딩일기/Git

[Git] gitignore이란?

by 욱파이어니어 2021. 9. 28.
728x90
반응형

이번에 날씨 앱 만들기 프로젝트를 진행하는데 git에 내 api키를 그대로 올려 놓은것이 신경쓰여서 숨기는 방법을

알아보다 gitignore에 대해서 알게되었다.

 

gitignore이란?

 

gitignore은 말 그대로 github에 프로젝트를 올릴때 github에서 무시했으면 하는 정보, 파일들을 입력하는 파일이다.

보통은 나처럼 API키와 같은 정보들을 gitignore에 집어 넣어서 보안을 높인다.

 

 

그럼 이제 gitignore를 사용하는 방법에 대해서 알아보자.

 

 

 

gitignore 사용법

 

gitignore를 사용하는 방법은 아래의 순서대로 만들면 된다.

 

 

 

1. gitignore 파일을 만든다.

2. gitignore 파일을 프로젝트 파일 최상단에 넣는다.

 

 

그럼 이제 각각의 순서대로 자세히 알아보자.

 

 

1. gitignore 파일을 만든다.

 

gitignore 파일을 만드는 방법은 간단하다 아래 사이트에 들어가서

 

https://www.toptal.com/developers/gitignore

 

gitignore.io

Create useful .gitignore files for your project

www.toptal.com

 

프로젝트를 진행하고 있는 운영체제와 언어를 입력하면 된다.

나같은 경우는 안드로이드와 자바를 사용하고 있기때문에 자바와 안드로이드를 입력했다.

 

그렇게 입력을 하면 아래와 같은 정보들이 나온다.

# Created by https://www.toptal.com/developers/gitignore/api/androidstudio,java
# Edit at https://www.toptal.com/developers/gitignore?templates=androidstudio,java

### 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*

### AndroidStudio ###
# Covers files to be ignored for android development using Android Studio.

# Built application files
*.apk
*.ap_
*.aab

# Files for the ART/Dalvik VM
*.dex

# Java class files

# Generated files
bin/
gen/
out/

# Gradle files
.gradle
.gradle/
build/

# Signing files
.signing/

# Local configuration file (sdk path, etc)
local.properties

# Proguard folder generated by Eclipse
proguard/

# Log Files

# Android Studio
/*/build/
/*/local.properties
/*/out
/*/*/build
/*/*/production
captures/
.navigation/
*.ipr
*~
*.swp

# Keystore files
*.jks
*.keystore

# Google Services (e.g. APIs or Firebase)
# google-services.json

# Android Patch
gen-external-apklibs

# External native build folder generated in Android Studio 2.2 and later
.externalNativeBuild

# NDK
obj/

# IntelliJ IDEA
*.iml
*.iws
/out/

# User-specific configurations
.idea/caches/
.idea/libraries/
.idea/shelf/
.idea/workspace.xml
.idea/tasks.xml
.idea/.name
.idea/compiler.xml
.idea/copyright/profiles_settings.xml
.idea/encodings.xml
.idea/misc.xml
.idea/modules.xml
.idea/scopes/scope_settings.xml
.idea/dictionaries
.idea/vcs.xml
.idea/jsLibraryMappings.xml
.idea/datasources.xml
.idea/dataSources.ids
.idea/sqlDataSources.xml
.idea/dynamic.xml
.idea/uiDesigner.xml
.idea/assetWizardSettings.xml
.idea/gradle.xml
.idea/jarRepositories.xml
.idea/navEditor.xml

# OS-specific files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# Legacy Eclipse project files
.classpath
.project
.cproject
.settings/

# Mobile Tools for Java (J2ME)

# Package Files #

# virtual machine crash logs (Reference: http://www.java.com/en/download/help/error_hotspot.xml)

## Plugin-specific files:

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Mongo Explorer plugin
.idea/mongoSettings.xml

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

### AndroidStudio Patch ###

!/gradle/wrapper/gradle-wrapper.jar

# End of https://www.toptal.com/developers/gitignore/api/androidstudio,java

 

 

이제 이 내용들을 메모장에다가 넣고 

위 사진처럼 형식을 만들어서 저장을 해주면 된다.

 

그럼 이제 이 .gitignore 파일을 프로젝트 최상단에 올려두자.

 

 

 

 

 

2. gitignore 파일을 프로젝트 파일 최상단에 넣는다.

 

1번에서 만든 .gitignore파일을 프로젝트 파일에서 최상단에 놓는다.

 

이게 무슨말이냐면 

내가 Weather이라는 프로젝트 파일안에 .gitignore를 넣으면 된다.

 

 

 

위 과정을 했다면 이제 commit을 하면된다.

 

 

반응형