Git 직접 동기화로 재택근무 생산성 높이기

출근과 재택 근무를 병행하면서 한곳에서 하던 작업을 편하게 이어서 하기 위해 여러가지 시도를 했다. 집에서 회사 컴퓨터에 로그인해서 일하는 대신 로컬 컴퓨터에서 CLI와 GUI를 함께 쓰며 쾌적하게 작업하는 것이 목표였다.

몇가지 시행착오 후 만족스런 방법을 찾았는데, 회사 아이맥에서 작업하던 Git repository를 집에서 쓰는 맥북과 Git으로 ‘직접 동기화’하는 것이다. 두 local repository를 GitHub이나 GitLab 같은 서버 역할을 하는 remote를 거치지 않고 직접 연결하는 방법이다.

맥을 사용하는 것을 전제로 설명하지만 Git을 활용하는 방법이 주요 내용이라 맥 사용자가 아니라도 참고해서 활용할 수 있을 것이다.

시행착오

처음에는 집에서 회사 아이맥에 SSH로 접속하는 방법을 썼다. 일을 주로 CLI에서 하니 그럭저럭 할만하긴 했다. 하지만 SourceTree나 VS Code 같은 GUI 앱이 필요할 때 사용할 수 없어서 불편했다. Screen Sharing으로 실행할 수는 있지만 속도가 느리고 한/영 전환 등 키매핑 관련 문제 때문에 불편하다.

다음 시도는 SSHFS나 맥의 File Sharing 으로 회사 아이맥의 파일을 맥북에서 로컬 파일처럼 접근하는 것이었다. 논리적으로는 첫번째 방법의 문제를 해결할 수 있을 것 같았지만 파일 시스템의 반응이 너무 느려서 쓸 수 없었다.

다음은 rsync로 파일을 동기화하는 방법이다. 로컬 파일을 사용할 수 있어서 반응이 빠르지만 역시 아래와 같은 문제로 해결책이 되지 못했다.

• 단방향 동기화만 지원.
• 동기화 대상에서 제외해야 하는 파일을 일일히 rsync의 설정으로 관리해야 함. 대상을 .gitignore 에서 이미 관리하고 있는데 그것을 다시 rysnc의 설정으로 만들어야 한다.

찾아보니 양방향 파일 동기화를 지원하는 Unison이라는 도구가 있었다. 이것도 해결책이 될 수 없었는데 아래와 같은 문제 때문이다.

• 사용법이 직관적이지 않음
• 양쪽에서 동일한 곳을 수정했을 때 충돌(conflict) 해결이 쉽지 않다.
• 파일을 잘못 변경하거나 삭제하면 복구하기가 어렵다.

Git으로 해결

작업 내용을 양방향으로 동기화할 수 있고 conflict를 잘 처리할 수 있으며 뭔가 문제가 생겼을 때 쉽게 복구할 수 있는 도구가 필요한 것인데, 등잔 밑이 어둡다고 이런 일을 가장 잘 해내는 도구가 이미 쓰고 있는 Git이었다. 동기화 대상에서 제외해야하는 파일들이 이미 .gitignore에 설정되어 있으니 따로 신경쓸 필요도 없다.

하지만 일반적인 작업 플로우처럼 GitHub이나 GitLab 같은 origin으로 push한 후 다른 컴퓨터에서 pull하는 방식은 부적합하다. push하기 전에 논리적인 작업 단위로 commit들을 나누고 commit 메시지도 잘 정리해서 써야 하는데 두 컴퓨터 간 동기화를 위해 급하게 commit을 해야 하면 제대로 하기 어렵기 때문이다.

Git repository 간 직접 동기화

해결책은 origin을 거치지 않고 두 컴퓨터의 Git resository 간 직접 동기화를 하는 것이다. Git은 각 repository가 동등한 위상을 가지는 분산 시스템이기 때문에 origin을 거치지 않아도 동기화를 할 수 있다.

Git의 강점 중 하나는 동료들과 함께 사용하는 remote에 push하기 전에는 로컬에서 얼마든지 commit history를 수정할 수 있다는 것이다. 언제든 변경을 저장하고 싶으면 임시 commit들을 대강 만들면 된다. 이후 적절한 시점에 git reset 명령으로 임시 commit들을 취소한 후에 정식으로 commit할 수 있다.

혼자 사용하는 두 컴퓨터의 repositoy 를 pull 또는 push로 동기화하는 것도 동료에게 commit을 공유하지 않는 것이라 마찬가지 방법을 쓸 수 있다. 즉 동기화가 필요하면 임시 commit을 대강 만들어서 다른 쪽에 넘긴다. 임시 commit을 받아간 곳에서 작업을 이어 하다가 적절한 시점에 reset 후 commit을 다시 다듬어서 만들면 된다.

git fetch (pull)로 동기화하는 예제

회사 아이맥에서 하던 작업을 임시 commit한 후 맥북으로 넘기는 명령어 예제이다.

아래와 같은 환경이다.

• 맥북에서 아이맥으로 SSH 연결이 가능하다.
• 맥북에서 아이맥을 ‘imac’ 으로 name lookup 할 수 있는 상황이다. DNS에 등록되어 있지 않아서 /etc/hosts 에 설정했다.
• 두 컴퓨터 간에 서로 SSH 접속이 되는 상황이다. 집에서는 회사 VPN을 통해 아이맥에 접속한다. 출근할 때는 회사로 맥북을 가져가서 아이맥에서 맥북으로 접속하는 방법을 쓴다. 집에 컴퓨터를 둔 상태에서 회사에서 접속하려면 집 인터넷 공유기에 적절한 설정을 하면 되겠다.
• 두 컴퓨터 모두 ~/sample_proj/ 에 Git local environment¹ 가 위치한다.

아이맥에서 하던 작업을 맥북으로 넘기는 명령어를 요약하면 아래와 같다. 두 컴퓨터에서 모두 current branch(HEAD)는 master다.

 1# imac에서 실행
 2$ cd ~/sample_proj
 3$ touch b
 4$ git add .
 5$ git commit -m 'Temparary save'
 6
 7# macbook에서 실행
 8$ cd ~/sample_proj
 9$ git remote add imac psh@imac:sample_proj/
10$ git fetch imac
11$ git merge imac/master
12$ git reset HEAD^ # 임시 commit은 없애고 변경한 내용만 남김
13
14# imac에서 실행
15$ git reset --hard HEAD^ # 임시 commit과 변경한 내용 모두 없앰.
16

하나씩 설명하면 아래와 같다.

1. 작업 전 아이맥의 ~/sample_project/ 에서 상태를 확인한다.

1# imac에서 실행. current branch(HEAD)는 master다. 
2$ cd ~/sample_proj
3$ git log --oneline
4f5bffbb (HEAD -> master, origin/master) first commit
5
6$ ls
7a

2. 아이맥에서 파일 b를 추가하고 임시 commit을 한다.

1# imac
2$ touch b
3$ git add .
4$ git commit -m 'Temparary save'

3. 맥북에서 아래처럼 imac 이라는 remote를 추가한다.

1# macbook
2$ cd ~/sample_proj
3$ git remote add imac psh@imac:sample_proj/ # SSH 프로토콜로 리모트 설정

SSH 프로토콜을 사용했다. 만약 SSH를 사용할 수 없다면 다른 프로토콜을 사용할 수 있다.

4. imac의 commit들을 fetch하고 아이맥에서 만든 임시 commit을 master branch에 merge한다.

1# macbook에서 실행. current branch(HEAD)는 master다.
2$ git fetch imac
3$ git merge imac/master # 두개 명령을 묶어서 git pull imac master 라고 해도 된다.

5. 임시 commit이 맥북에도 추가된 것을 확인할 수 있다.

1# macbook
2$ git log --oneline
3e88d46f (HEAD -> master, imac/master) Temparary save
4f5bffbb (origin/master, origin/HEAD) first commit

6. 임시 commit에 의한 변경 내용만 working directory에 남기고 임시 commit 자체는 취소한다.

1#macbook
2$ git reset HEAD^  # current commit 에서 1개만 되돌리면 되므로 HEAD^ 을 지정

git reset에 따로 옵션을 지정하지 않았으니 --mixed 옵션이 있는 것과 마찬가지다. 이렇게 하면 current branch인 master의 위치를 임시 commit 이전으로 돌리지만 working directory는 그대로 둔다. 즉 임시 commit 의 작업 내용은 working directory 에 그대로 있기 때문에 새로 잘 다듬어서 commit할 수 있다.

7. git reset에 의한 결과를 아래처럼 확인할 수 있다.

1# macbook
2$ git log --oneline
3f5bffbb (HEAD -> master, origin/master, origin/HEAD) first commit
4
5$ ls
6a b

임시 commit은 없어졌지만 그것에 의해 추가된 b는 working 디렉토리에 있다.

8. 아이맥에서 임시 commit을 삭제하고 그것에 의한 working directory 변경까지 모두 되돌린다.

1# imac
2$ git reset --hard HEAD^

맥북으로 작업을 넘겼기 때문에 아이맥에선 변경한 내용을 깨끗이 지운 것이다.

reset 에 --hard 옵션을 주었기 때문에 working directory까지 HEAD^(f5bffbb) 의 것으로 되돌렸다.

9. git reset –hard 의 결과를 아래처럼 확인할 수 있다.

1# imac
2$ git log --oneline
3f5bffbb (HEAD -> master, origin/master) first commit
4$ ls
5a

git push로 동기화 하는 방법

fetch (또는 pull) 대신 push를 쓸 수도 있다. 위에서 설명한 fetch 방식이 더 이해하기 쉽고 편리하니 그렇게 할 수 있다면 이 방법은 사용할 필요가 없다. 하지만 두 컴퓨터 간의 SSH 연결을 한 방향으로만 할 수 있는 환경이라면 해결책이 될 수 있다.

맥북의 master branch에서 임시 commit한 것을 아이맥의 master branch로 push하려면 아래처럼 한다.

1. 아이맥의 current branch 를 push 대상인 master가 아닌 다른 것으로 바꿔둔다.

1# imac
2$ git branch tmp
3$ git checkout tmp  # push 대상 branch에서 다른 곳으로 잠시 피한다.
4Switched to branch 'tmp'

이렇게 하지 않으면 push할 때 에러가 발생한다.

2. 맥북에서 아이맥으로 push한다.

1# macbook
2$ git push imac master

checkout된 branch에 push하면 에러가 발생하는 이유

위에서 맥북에서 master branch를 아이맥의 master로 push하기 전에 아이맥에서 먼저 master가 아닌 다른 branch로 checkout 했다.

만약 아이맥에서 master branch에 checkout한 상태에서 push하면 아래와 같은 에러가 발생한다.

 1# macbook
 2$ git push imac master
 3...
 4remote: error: refusing to update checked out branch: refs/heads/master
 5remote: error: By default, updating the current branch in a non-bare repository
 6remote: is denied, because it will make the index and work tree inconsistent
 7remote: with what you pushed, and will require 'git reset --hard' to match
 8remote: the work tree to HEAD.
 9remote:
10remote: You can set the 'receive.denyCurrentBranch' configuration variable
11remote: to 'ignore' or 'warn' in the remote repository to allow pushing into
12remote: its current branch; however, this is not recommended unless you
13remote: arranged to update its work tree to match what you pushed in some
14remote: other way.
15remote:
16remote: To squelch this message and still keep the default behaviour, set
17remote: 'receive.denyCurrentBranch' configuration variable to 'refuse'.
18To imac:sample_proj/
19 ! [remote rejected] master -> master (branch is currently checked out)
20error: failed to push some refs to 'imac:sample_proj/'
21

위 에러 메시지의 안내대로 아래처럼 receive.denyCurrentBranch를 ignore로 설정하면 에러가 발생하지 않는다.

1# imac
2$ git config receive.denyCurrentBranch ignore

하지만 이렇게 하는 것은 좋지 않은 방법이다. 아이맥의 local environment 가 혼란스러운 상태에 빠질 수 있기 때문이다.

chekout한 branch( current branch )에 push하면 push된 commit들이 current branch 에는 추가되지만 working directory는 그대로 두기 때문에 문제가 된다. 즉 push 전에 clean한 상태 (git diff를 실행하면 아무것도 나오지 않는 상태) 였다고 해도 push 후에 current commit(HEAD)의 내용과 working directory의 내용이 달라진다.

예를 들어 push된 commit에 의해 기존에 없던 a.txt 라는 파일이 추가되었다면 working directory에는 그 파일이 여전히 없기 때문에 마치 이전 commit에 있었던 a.txt를 working directory에서 삭제한 것처럼 보이게 된다.

GitLab 이나 GitHub 을 가리키는 remote에 push할 때는 이런 문제가 없는데, 그곳에 있는 것은 working directory가 없는 bare repository 이기 때문이다.