Android Studio / Github 연동

Android Studio IDE 로 작업을 하면서 코드 형상 관리를 위해 Github 를 사용하는 경우가 있다. 

 

Android Studio 와 Github 를 연동하는 방법은 다음과 같다. 

 

---

확인 진행한 환경 :

 

Android Studio 3.5

git version 2.23.0.windows.1

 

(git 미설치시 [Windows 내 git 설치] 참고)

---

 

현재 작업 중인 프로젝트를 처음으로 github에 연동하는 경우

 

1. 불필요한 파일을 연동에서 제외 시키기 위한 파일 (.gitignore) 작성
   1. .gitignore 생성을 위한 ".ignore" plugin 설치
   2. 제외 파일/폴더 정의를 위한 .gitignore 자동 생성
2. "Share Project on Github" 를 통한 연동
3. 기타 Trouble shootings
   1. "Can't finish Github sharing process"

---

1. 불필요한 파일을 연동에서 제외 시키기 위한 파일 (.gitignore) 작성

 

1-1. .gitignore 생성을 위한 ".ignore" plugin 설치

 

Android Stuio > File > Settings > Plugins 내에서 "ignore" keyword 검색

.ignore 을 선택하고 설치한다. 

 

1-2. 제외 파일/폴더 정의를 위한 .gitignore 자동 생성

 

Plugin 설치 후 Android Studio 를 재실행 하고 

Android Studio > File > New > .ignore file > .gitignore file (Git) 을 선택한다. 

github repository 에 연동되어서는 안되는/필요가 없는 파일들을 정의해야 하는데, 자신이 사용할 Language, OS, IDE 등을 선택하면 불필요한 파일들을 연동에서 제외 시켜주는 .gitignore 파일을 자동생성한다. 

(자체적으로는 kotlin, android, jetbrains, gradle을 선택하여 생성하였다.)

 

이후 "Generate without duplicates" 를 선택하면 .gitignore 파일이 자동으로 생성되고, github연동시 해당 파일/폴더들은 제외된다. 

 

 

 

2. "Share Project on Github" 를 통한 연동

 

Android Studio > VCS > Import into Version Control > Share Project on Github 

위 경로를 선택하면 github 와의 실질적인 연동이 시작된다.

 

메뉴 선택 후 Github Login 창이 발생하는데 기존에 보유 중인 ID / Password를 입력하여 Log in 한다. 만약에 없다면 "Sign up for Github"를 선택하여 계정을 생성한다. 

Repository name 에는 Github 상에서 관리/표시될 Repository 이름을 정하여 입력한다. 

이후 Description을 채워넣고, Share 버튼을 선택한다. 

Initial Commit 을 할 파일들을 선택하는데 앞서 생성한 .gitignore 에 표시된 패턴의 파일/폴더들은 제외된다. 

이후 Add 버튼을 누르면 Github로의 연동이 모두 마무리 되고, 아래와 같이 Github 접속이 정상적으로 Push 된 것을 확인 할 수 있다. 

 

3. 기타 Trouble shootings

 

3-1. "Can't finish Github sharing process"

git 자체를 처음 설치하고, 바로 github로 share 하는 경우 다음과 같은 에러를 볼 수 있다. 

Can't finish Github sharing process Successfully created project 'KotlinYoutubeApi_Sample' on GitHub, but Initial commit failed: *** Please tell me who you are. Run git config --global user.email "you@example.com" git config --global user.name "YourName" to set your account's default identity. Omit --global to set the identity only in this repository. unable to auto-detect email address (got 'OOO@OOOOOOO.(none)')

이는 이후 코드 작업 후 Github에 Push 할 때 사용자에 대한 정의가 되어 있지 않을 경우에 발생하는데 git 설치 이후 별다른 설정을 하지 않았다면 해당 정보가 없기 때문에 github로 연동할 때에도 위와 같이 발생할 수 있다. 

 

해당 설정은 Android Studio에서 별도의 UI를 제공하지 않아 command 로 설정을 해주어야 한다. 

설정을 위해서는 아래와 같이 git 설치시 같이 설치되는 "git bash" 를 실행시키고 진행하면 된다.

 

OOO@DESKTOP-G0GRUL2 MINGW64 /d/workspace $ git config --global user.email "technotecode@gmail.com" OOO@DESKTOP-G0GRUL2 MINGW64 /d/workspace $ git config --global user.name "TechNote"

github와 연동 도중에 에러가 발생하였다면 연동이 그 상태로 중단되었을 텐데, 연동 마무리를 위해서는 위 설정 이후 다시 한번 Commit / Push 를 진행하여야 한다. 

 

위와 같이 Commit / Push를 다시 진행하면 github 접속시 정상적으로 연동된 것을 확인할 수 있다.