[Git] Repo 설치 및 사용

Repo란?

• Repo란 필요시 여러가지 Git repository를 통합하여 Android 개발 workflow를 자동화합니다.
• Repo는 Git을 대체하는 것이 아닌 Android의 컨텍스트에서 Git을 쉽게 작업할 수 있도록 하는데 목적이 있습니다.
• Repo는 manifest 파일을 이용하여 Android 프로젝트에 Git 프로젝트를 모아둡니다.
• repo 명령어는 경로 어디에나 삽입할 수 있는 실행 가능한 Python 스크립트입니다.
• 참조(https://source.android.com/setup/develop#installing-repo)

Repo 설치

# Debian/Ubuntu
$ sudo apt-get install repo

# Gentoo.
$ sudo emerge dev-vcs/repo

많은 배포판에 repo가 포함되어 있으므로 바로 설치가 가능합니다.

$ mkdir -p ~/.bin
$ PATH="${HOME}/.bin:${PATH}"
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
$ chmod a+rx ~/.bin/repo

repo 명령어들이 python 스크립트로 이루어져 있다는 것을 알 수 있습니다.

Manifest 파일

• repo manifest 파일은 Git에서 받을 수 있는 폴더들에 대한 repo 클라이언트의 구조를 설명합니다.
• manifest의 기본 구조는 최상위 폴더의 default.xml 파일을 가지고 있는 Git 저장소입니다.
• manifest는 Git 저장소에 보관되므로 버전관리를 할 수 있으며, repo sync를 통해 모든 Git 저장소의 변경사항을 가져옵니다.

# default.xml

<?xml version="1.0" encoding="UTF-8"?>
<manifest>
    <remote
        name="origin"
        fetch="ssh://git@github.com"/>
    <default revision="master" remote="origin"/>

    <project
        path="Item1"
        name="ows3090/RepoItem1"/>
    <project
        path="Item2"
        name="ows3090/RepoItem2"/>
    <project
        path="Item3"
        name="ows3090/RepoItem3"/>
</manifest>

• RepoTest라는 원격 저장소에 다음 default.xml 파일이 존재합니다.
• manifest 파일의 이름은 무조건 default.xml일 필요는 없고, 다른 이름을 할 경우 repo init시에 -m 옵션으로 파일명을 알려줘야 합니다.
• 파일명을 적지 않을 경우 default.xml 파일명을 manifest 파일로 간주합니다.

< manifest >
파일 루트 요소

< remote >
하나 이상의 remote element를 지정할 수 있습니다. 굵게 표시한 태그는 필수로 있어야 할 태그들입니다.

• name : manifest file에서 유일한 이름으로 각 프로젝트의 .git/config에 적혀있는 원격 저장소으로 지정된 이름
• fetch : 이 remote 사용하는 모든 프로젝트의 Git URL prefix, 이 prefix에 project의 name이 추가되어 clone합니다.
• alias : name에 적혀있는 원격 저장소 이름을 override한 이름
• pushurl : 이 remote를 사용하는 모든 project들에 대한 Git push ULR prifix, 이 preifx에 project의 name이 추가되어 push합니다. pushurl이 지정되지 않은 경우 fetch URL로 push 됩니다.
• review : repo upload 시 review 시스템에 업로드할 gerrit의 호스트 네임
• revision : Git branch 이름

< default >
default element는 오직 하나만 기술합니다. project 태그가 자신의 remote 또는 revision 속성을 가지지 않을 경우에 기본값으로 이 정보를 사용합니다. 굵게 표시한 태그는 필수로 있어야 할 태그들입니다.

• remote : remote element에 정의된 원격 저장소 이름
• revision : project의 revision 속성이 없는 경우 사용되는 Git branch 이름
• dest-branch : project의 des-branch 속성이 없는 경우 사용되는 Git branch 이름
• sync-j : sync 작업 시 병렬로 작업할 갯수
• sync-c : true시, revision에 주어진 git branch만 sync 합니다.
• sync-s : true시, sub-project도 sync 합니다.

< project >
project element는 하나 이상 기술할 수 있습니다. 각 element는 원격 저장소의 정보를 가지고 있으며, 해당 git repository에 clone합니다. 굵게 표시한 태그는 필수로 있어야 할 태그들입니다.

• name : project 이름, Git remote URL은 ${remote_fetch}/${project_name}.git 으로 설정됩니다.
• path : 최상위 디렉토리로부터의 상대적인 경로, 이 경로에 project가 clone 받아집니다. 만약 속성이 없는 경우 project 이름으로 폴더 생성하여 받습니다.
• remote : remote 태그에 정의된 name
• revision : 이 project가 tracking 하길 원하는 Git branch 이름
• dest-branch : repo upload시에 사용될 Git branch 이름
• groups : 이 project가 속해 있는 group 리스트
• sync-c : true시, revision에 주어진 git branch만 sync 합니다.
• sync-s : true시, sub-project도 sync 합니다.
• 참조(https://gerrit.googlesource.com/git-repo/+/master/docs/manifest-format.md)

repo의 init 명령어

$ repo init -u url [options]

현재 폴더에 Repo를 설치합니다. 이 명령어는 Repo 소스 코드 및 표준 Android manifest 파일의 Git 저장소가 포함된 .repo 폴더를 생성합니다.

• -u : manifest가 있는 저장소 URL을 지정합니다.
• -m : 저장소에서 manifest 파일을 선택합니다. manifest 이름을 지정하지 않으면 기본값이 default.xml입니다.
• -b : branch명을 지정합니다.
• 자세한 옵션에 대한 설명은 공식문서 확인하면 됩니다.

repo의 sync 명령어

$ repo sync [project-list] [options]

새로운 변경사항을 다운로드하여 로컬 파일들을 업데이트하도록 전체 Git 저장소에 걸쳐 git fetch를 실행합니다. project-list를 명시하지 않으면 repo sync 실행 시 모든 프로젝트 파일을 sync 합니다.

# 프로젝트가 sync 된 적이 없을 경우, git clone 과 같이 원격 저장소의 파일이 로컬 파일로 복사됩니다.
$ git clone

# 이전에 프로젝트가 sync 된 적이 있을 경우
$ git remote update
$ git rebase origin/branch

• -c : manifest branch만 가져옵니다.
• -j : repo sync를 여러 스레드로 분할하여 완료 시간을 단축합니다. 사용 가능한 CPU 수를 보기 위해서는 nproc --all 입력해서 확인할 수 있습니다.
• 자세한 옵션에 대한 설명은 공식문서 확인하면 됩니다.

manifest 계층 구조

AOSP를 repo를 통해 다운로드 받을 시 모든 프로젝트를 받을 필요는 없습니다.
remove-project 태그를 이용하여 필요하지 않는 프로젝트는 제외하여 받을 수 있습니다. 하지만 default.xml의 project 태그 중간에 넣는 방법은 나중에 rebase시 충돌이 날 수 있습니다. 따라서 새로운 xml을 생성하여 계층구조를 만듦으로써 해결할 수 있습니다.

<?xml version="1.0" encoding="UTF-8"?>
<manifest>
    <remote
        name="origin"
        fetch="ssh://git@github.com"/>
    <default revision="master" remote="origin"/>

    <project
        path="Item1"
        name="ows3090/RepoItem1"/>
    <project
        path="Item2"
        name="ows3090/RepoItem2"/>
    <project
        path="Item3"
        name="ows3090/RepoItem3"/>

    <repo-hooks in-project="ows3090/RepoItem2" enabled-list="pre-upload"/>
    <include name="removeItem.xml"/>
</manifest>

ows3090/RepoItem2의 프로젝트를 제외하고 싶을 경우 repo-hooks 태그와 include 태그를 통해 제외할 수 있습니다.
repo-hooks 태그로 지정된 프로젝트 이전에 include 되는 xml을 추가한다는 뜻입니다.

<?xml version="1.0" encoding="UTF-8"?>
<manifest>
    <remove-project name="ows3090/RepoItem2"/>
</manifest>

다음은 removeItem.xml입니다. 여기서 remove할 프로젝트를 지정하여 제외하였습니다.

결과를 확인해봐도 Item2 프로젝트 제외하고 clone하였습니다.

각종 Repo 명령어

• 참조(https://source.android.com/setup/develop/repo)