Wednesday, November 14, 2012

Перевод проекта с SVN на Git

Хочу поделиться своим опытом перевода существующего проекта с SVN на Git. В интернете достаточно много материала на эту тему, но, на мой взгляд там представлены достаточно кусочные решения, которые нужно собрать вместе и тогда все будет работать как надо.

Прежде всего, для работы нам понадобится Git, который можно скачать здесь, и SVN репозиторий, который будем мигрировать.

Сразу хочу отметить, что это ни в коем случае не документация по Git - я не волшебник, я только учусь :)

Миграция SVN-репозитория состоит из нескольких шагов: клонирование, создание ветвей, создание тэгов, очистка Git-репозитория от артефактов SVN, публикация локального репозитория в удаленный.

Для каждого из шагов я сделал отдельный скрипт, который позволяет выполнить все шаги по отдельности в ручном режиме.

Клонирование

Клонирование - самый длительные процесс. В зависимости от размера репозитория может занимать время от нескольких минут, до нескольких часов. Проект, миграцию которого я осуществлял, занимал приблизительно 300 МБ, в нем было около десятка ветвей и тэгов и процесс клонирования занимал 1.5 - 2 часа, на моем ноутбуке.

#!/bin/sh
DIR=${0%/`basename $0`}
REPOSITORY_URL=$1
REPOSITORY_PATH=$2
AUTHORS_FILE=$3

git init ${REPOSITORY_PATH}

cd ${REPOSITORY_PATH}
git config core.autocrlf false
cd ${DIR}

git svn clone ${REPOSITORY_URL} ${REPOSITORY_PATH} -A${AUTHORS_FILE} -bbranches -Ttrunk -ttags --no-metadata --prefix=svn/


Этот скрипт создает Git-репозиторий по пути ${REPOSITORY_PATH}, устанавливает свойство core.autocrlf (подробнее об этом ниже), запускает команду клонирования SVN-репозитория доступного по адресу ${REPOSITORY_URL} в Git-репозиторий ${REPOSITORY_PATH}.

Отдельное внимание надо уделить ключам -A, --prefix, --no-metadata, -b, -T,-t.

-A - путь к файлу со списком авторов - проще говоря мэппинг между пользователями SVN и Git. Все дело в том, что в Git пользователь идентифицируется по паре - имя пользователя - e-mail адрес пользователя:

user1=FirstName1 LastName1 <user1@email.com>
user2=FirstName2 LastName2 <user2@email.com>
user3=FirstName3 LastName3 <user3@email.com>

--prefix - указывает, что все содержимое из SVN-репозитория нужно положить в Git-репозиторий по пути с префиксом, указанном в этом ключе. Таким образом потом проще удалить ненужные вещи.

-b, -T и -t - указывают на положение веток, транка и тэгов в SVN. Это нужно для того, чтобы во время клонирования к имени добавился префикс branch, trunk и tag соответственно и проще было отличить одно от другого в Git-репозитории.

--no-metadata - удаляет информацию о номерах SVN-ревизий и возможно другие метаданные. Есть мнение что этого делать не нужно, особенно если есть документация, которая ссылается на номера SVN-ревизий (мнение здесь).

Чуть не забыл упомянуть про конфигурационный параметр core.autocrlf - этот параметр контролирует поведение Git по отношению к переводам строк для тестовых файлов. Если данны параметр установлен в значение false, то Git не будет делать никаких преобразований. Подробнее об этом советую почитать в документации.


Создаем ветви

Далее все достаточно скучно :) Ниже предствелен скрипт для создания ветвей в Git, на основе тех данных, которые получились в результате клонирования на предудыщем шаге.

#!/bin/sh

DIR=${0%/`basename $0`}
REPOSITORY_PATH=$1

cd ${REPOSITORY_PATH}

# create master branch out of trunk
git branch -D -r svn/trunk

# create rest branches
git for-each-ref --format="%(refname)" "refs/remotes/svn/*" | while read r; do 
  branch=${r#refs/remotes/svn/};
  echo "Migrating branch ${branch}";
  git checkout -b ${branch} remotes/svn/${branch}
  git branch -D -r svn/${branch} 
done

# switch working copy to master branch
git checkout master

cd ${DIR}

Создаем тэги

Все точно так же скучно, только кода больше:

#!/bin/sh

DIR=${0%/`basename $0`}
REPOSITORY_PATH=$1

cd ${REPOSITORY_PATH}

git for-each-ref --format='%(refname)' refs/remotes/svn/tags/* | while read r; do
  tag=${r#refs/remotes/svn/tags/}
  sha1=$(git rev-parse "$r")

  commiterName="$(git show -s --pretty='format:%an' "$r")"
  commiterEmail="$(git show -s --pretty='format:%ae' "$r")"
  commitDate="$(git show -s --pretty='format:%ad' "$r")"

  # Print the commit subject and body separated by a newline
  comment=`git show -s --pretty='format:%s%n%n%b' "$r"`
  echo "Comment: ${comment}"

  export GIT_COMMITTER_EMAIL="$commiterEmail"
  export GIT_COMMITTER_DATE="$commitDate" 
  export GIT_COMMITTER_NAME="$commiterName"

  git tag -f -a "$tag" "$sha1" -m "${comment}"
  flag=$?
  
  if [ "${flag}" == "0" ]; then
    echo "Tag: ${tag} sha1: ${sha1} using '${commiterName}', '${commiterEmail}' on '${commitDate}'"

    # Remove the svn/tags/* ref
    git update-ref -d "$r"
  fi
done

cd ${DIR}

Очистка Git-репозитория

На этом шаге удаляем все, что осталось от наследия SVN из нашего нового репозитория:

#!/bin/sh

DIR=${0%/`basename $0`}
REPOSITORY_PATH=$1

cd ${REPOSITORY_PATH}
git branch -rd git-svn
git config --remove-section svn-remote.svn
git config --remove-section svn
rm -rf .git/svn
rm -rf .git/refs/remotes/svn
cd ${DIR}

Публикация локального репозитория в удаленный

После того как мы получили готовый Git-репозиторий, можно приступить к его публикации на удаленном сервере, например BitBucket или GitHub.

#!/bin/sh

DIR=${0%/`basename $0`}
REPOSITORY_PATH=$1
REMOTE_ALIAS=$2
REMOTE_URL=$3

cd ${REPOSITORY_PATH}

# add alias for remote repository
git remote add ${REMOTE_ALIAS} ${REMOTE_URL}

# push all branches
git for-each-ref --format="%(refname)" "refs/heads/*" | while read r; do 
  branch=${r#refs/heads/};
  echo "Pushing branch ${branch}";
  git push -u ${REMOTE_ALIAS} heads/${branch}
done

# push all tags
git push --tags ${REMOTE_ALIAS}

${REMOTE_ALIAS} - псевдоним удаленного репозитория, чтобы каждый раз не писать длинный URL. Сохраняется в конфигурационном файле репозитория .git/config.

No comments:

Post a Comment