SPLIT POST COMMIT HOOK позволяет создавать и поддерживать новый Репозиторий SVN/GIT/HG на основании списка файлов. Может использоваться для различных решений автоматизации.
- Не имеет зависимостей от нестандартных библиотек.
- Написан на
C, совместимость стандарта отgnu99. - Компактный, 100
кб+ исполняемый файл, бережно работает с памятью, большая часть процедур реализована без динамического выделения памяти. - Протестирован на
WIN32 - WIN64платформах,ОСотWinXPдоWin10, так-же любыеPOSIXсовместимые платформы (*nix). - В среде
Windowsсборка проверена на:Visual Studio 2010-Visual Studio 2017(?).MinGW32иMinGW64,MinGW32-TDMверсия.
- Сценарий сборки выбран мультиплатформенный, с помощью
CMake.
- Поддерживает автоматическую работу с наиболее популярными
VCS:SVN/GIT/HG. - Автоматически выполняет необходимые
VCSкоманды по обновлению, изменению и публикации репозитория, в зависимости от прошедших обновлений. - Копирует файлы согласно списка. Список должен находиться в директории
masterрепозитория, его путь указывается относительно корня репозитория. - Отслеживает и убирает возможные дубликаты файлов и директорий в списке.
- Как автоматически, так и с помощью ключа
-uустанавливает пользователя и группу на создаваемые директории и файлы. Опция работает только дляPOSIXсовместимых операционных систем. - Возможно задавать или суффикс к копируемым файлам, или выражение замены части имени файла на другое, с помощью ключа
-x. - Возможность вести журнал операций для дальнейшего анализа проведенных обновлений, задать имя лог файла можно с помощью ключа
-j. - Возможность контролировать изменения в репозитории с помощью запуска тестов и по результатам принимать решение о внесении изменений. Есть два пути, возможно использовать оба варианта в одном репозитории:
- ключ
-dуказывает на скрипт или программу проверки изменений, например сборка проекта или иные тесты. - ключ
-yопределяет поиск конфигурационного файлаdeploy.yamlв корнеsplitрепозитория и выполнение команд описанных в нем. - В обеих случаях, успешное выполнение команд считается возврат
0, иначеcommitпроизведен не будет. Рабочие примеры скриптаdeploy.shи файлаdeploy.yaml.
- ключ
- При публикации
splitрепозитория, указывает в комментариях ревизию основногоmasterрепозитория и собственную версию. Это облегчает дальнейший поиск и анализ логирования транзакций. - Дополнительно возможно создавать архив в формате
zipс обновленными файламиsplitрепозитория и уникальным именем с указанием актуальной ревизии запакованных файлов. В архив включаются только измененные файлы. Так же в архив включен файлfilelist.xslistс архивированным списком, формат и структура файла -XML.
- Проект
Большая библиотекасозданиеразделенных частейбиблиотеки. - Проект
Очищенный релизсозданиеочищенногорелиза для публикации.
-m, --master 'val' master репозиторий, откуда копируем
-s, --split 'val' split репозиторий, куда копируем
-l, --list 'val' список копируемых файлов, задаеться от
корня master репозитория
-o, --rootsvn 'val' корневая директория SVN/GIT/HG
репозиториев, необязательный параметр
-e, --execdir 'val' путь к исполняемым файлам VCS,
для 'POSIX' систем по умолчанию /usr/bin
-j, --log 'val' путь и имя файла логирования
-u, --uid 'val' установить пользователя для файловых
операций (только Linux)
-d, --deploy 'val' deploy сценарий (скрипт), выполняеться
перед операцией 'commit', возвращает '0'
если тесты/сборка прошла удачна,
в противном случае 'commit' выполнен
не будет. (опционально)
-y, --yaml искать конфигурационный файл 'deploy.yaml'
в корне 'split' репозитория и в случае
успеха, выполнить команды описанные в нем.
Для работы необходим установленный
'bash shell' или 'ksh shell'(только Linux)
Формат 'yaml' файла описан ниже.
-x, --rename 'val' переименование или добавление префикса к
копируемым файлам: 'old=new' или 'new'
-t, --vcs 'val' тип используемой VCS: svn|git|hg
-c, --check 'val' проверять обновляемые файлы:
'c' (ctime) - дате создания,
'm' (mtime) - дате модификации,
's' (size) - по размеру,
'd' (default) - по умолчанию: 'm' и 's',
'a' (all) - по всем выше перечисленным
параметрам.
Пример синтаксиса: '--check cs', '--check a'
-r, --revision 'val' установить текущую ревизию копий файлов
относительно master репозитория
-g, --chnglog 'val' вести 'ChangeLog' в 'split' репозитории,
на основании коммитов в 'master' репозитории,
возможные форматы: md|gnu
-b, --backup 'val' создавать архив в формате 'zip' с
уникальным именем, в случае обновления
файлов в 'split' репозитории.
В качестве параметра передается полный
путь к директории где будут создаваться
архивы.
-f, --force перезаписывать все файлы, не проверяя
на изменения
-k, --nonloop предотвратить одновременный 'commit' и
'update' в мастер репозитории,
демонизирует процесс на время выполнения,
совместно с этим флагом крайне желательно
использывать опцию записи лога '-j'
-q, --quiet 'тихий режм', не выводить ничего на
консоль, работает только после обработки
параметров конфигурации заданных из
командной строки
-t, --template пример структуры XML файла списка
-i, --info подробное описание команд
-h, --help показать помощь по командам
Внимание, при использовании в скрипте
hooks/post-commitиспользование ключа-k, алиас--nonloop- ОБЯЗАТЕЛЬНО!В противном случае, например для
svnбудет происходить ошибка при попытке использовать методupdate, репозиторий будет находиться в состоянии.lockот предыдущей операцииcommitиз которой и вызывается данная программа.
Вы так-же можете использовать значения ключей в файле списка, секция settings/options. При этом единственные нобходимые ключи командной строки будут -m, --master и -l, --list. Получить структуру XML файла списка так-же можно запустив программу с ключем -t.
Файл справки по командам в формате man
Файлы списка могут иметь два формата:
XMLформат - примерXMLрасширенный формат, настройки репозитория - примерPlain TEXTформат - пример
Для создания рабочего списка на базе репозитория, возможно использовать SPCH List Builder, собранную версию можно загрузить:
- последние сборки архивов в формате ZIP/Nuget
- инсталляционный пакет в формате msi
- исходный код
C#в ZIP формате, необходим >= .NET 4.0
Файл должен находиться в корне split репозитория и содержать три значимых секции для команд:
- Секция
pre- команды выполняемые перед тестами или сборкой, код возврата команд не проверяется. - Секция
build- команды сборки и теста, проверяется код возврата команд, в случае успеха он должен быть0. - Секция
post- команды выполняемые после секцииbuild, код возврата команд не проверяется.
Пример файла deploy.yaml:
pre:
- cd build/
build:
- gcc -std=gnu99 -lm -I../src -o Test01 ../src/abc.c ../src/cba.c
- ./Test01
post:
- rm -f ./Test01
- echo "Ok"
Порядок выполнения в случае если указаны -d (--deploy) и -y (--yaml) ключи, следующий: сперва выполняется анализ и выполнение yaml конфигурационного файла, если проверка и тесты прошли успешно, выполняется скрипт заданный ключом -d и проверяется его возвращаемое значение.
При описании команд можно использовать предопределенные переменные:
$_ROOT- корневая директория репозитория: [полный путь].$_VCS_REVISION- текущая ревизия репозитория: [число].$_VCS_TYPE- типVCS: [svn|git|hg] .$_RC- код возврата последний команды из секцииbuild.$_REPO_NAME- название репозитория.$_BACKUP_ZIP- полный путь к текущему архиву, если был задан ключ-b.
Setup -> Root directory: /repo/split
Setup -> VCS revision: 160
Setup -> VCS type: svn
Pre-build cmd: cd build/
Examine cmd: /usr/bin/gcc -std=gnu99 -Wall -pedantic -I../src
-Wfatal-errors -pedantic-errors
../src/hashmap-link-hash.c ../test/main.c -o ./testDeployBuild
Examine cmd: ./testDeployBuild
17) Add: [217374]
19) Add: [925358]
...
37) [925358]
All Tests return 0
Post-build cmd: rm -f ./testDeployBuild
Post-build cmd: echo "Ok"
"Ok"
Есть возможность поддерживать отслеживаемую взаимосвязь между master и split репозиториями путем автоматического ведения ChangeLog файла.
ChangeLog файл создается и обновляется автоматически в split репозитории.
Актуальные данные в каждой записи указывают на ревизию обновления master репозитория и комментарии, тем самым легко проследить моменты и цели значимых модификаций.
Параметр -g, алиас --chnglog разрешает ведение ChangeLog файла в split репозитории.
Формат файла задается параметром ключа и может соответствовать форматам: md - MarkDown разметка, файл будет иметь расширение .md или gnu - текстовая разметка, файл будет иметь расширение .txt.
ChangeLogфайл обновляется только в случае актуальных изменений вsplitрепозитории.
Сборка производиться системой Cmake и не отличается по шагам от типовых случаев. Порядок действий:
- Получите дистрибутив исходных кодов
spchлюбым удобным для вас способом: клонируйте данный репозиторий, или загрузите его в формате zip архива. - Распакуйте полученный архив и перейдите в директорию
build. - Для
Windowsплатформы запуститеcmake-build-mingw.cmd, дляPOSIXсистем запуститеcmake-build-gcc.sh. - Если все прошло удачно, и сборка прошла без ошибок, исполняемый файл
spchилиspch.exeвы найдете в директорииbuild\bin. - Для
POSIXсистем в пакетный файл сборки включена командаinstall, если вы не переопределяли путь, исполняемый файл будет скопирован в директорию/usr/local/bin.
Так же вы можете взять собранные исполняемые и архивные файлы для 32/64 Windows платформ: w32 версия | w64 версия | релиз
Для
Windowsплатформы используйте компиляторMinGW, дляPOSIXплатформ должен используется компиляторgccилиclang. Возможно собратьspchвMSVC/MSVS, для этого используйте пакетный файлcmake-build-msvc.cmd. По умолчанию дляMSVC/MSVSсборка указана дляVisual Studio 15 2017.
Запускаться spch должен из скрипта VCS post-commit, точное название и местоположение зависимости от типа VCS и операционной системы. Файлы хуков VCS могут иметь отличные имена и располагаться согласно документации.
# пример для `svn`, файл `post-commit` находиться в директории
# текущего svn репозитория в подпапке `hooks`.
# структура `svn` репозитория:
conf/
db/
hooks/
locks/
README.txt
format
# вносим изменения в hooks/post-commit:
/usr/bin/spch \
-u svn \
-e /usr/bin \
-r "${2}" \
-t svn \
-k \
-y \
-o /home/svn/repo \
-m /home/user/MyLibRootRepo \
-s /home/user/__SplitRepo/MyLibSplitRepo_auto \
-l buildDirectory/split-repo.list \
-j /home/svn/spch_MyLibSplit.log \
-x mylib=libexport
# если используем файл 'yaml', не забываем добавить глобальное
# игнорирование файла deploy.yaml:
svn propset svn:global-ignores deploy.yaml
# или на уровне выбранного репозитория
svn propset svn:ignore deploy.yaml
Для
Windowsплатформ ключ-yне поддерживается, в связи с отсутствием полноценногоbash/kshинтерпретатора в базовой поставке.
[30060/30059][startedlog:102] -> spch v.0.0.9.62() 18.08
[30060/30059][startedlog:107] -> started at 08/30/18-06:16PM
[30060/30059][main:78] -> stage #0 non-loop mode: Parent 30060 successful exit
[30061/1][main:97] -> stage #0 check files mode: all - create, modify time and size
[30061/1][pch_stage2:154] -> stage #2 update: /repo/master/spch-link-hash.h -> /repo/split/hashmap-link-hash.h
[30061/1][pch_stage2:154] -> stage #2 update: /repo/master/spch-link-hash.c -> /repo/split/hashmap-link-hash.c
[30061/1][main:112] -> stage #2 changed repo objects: 2 -> /repo/split
[30061/1][pch_stage3:217] -> deploy script [buildDeploy.sh] start:
17) Add: [217374]
19) Add: [925358]
...
54) Dump
1) [139920]
2) [440839]
3) [925358]
[30061/1][pch_stage3:217] -> deploy script [buildDeploy.sh] - OK
[30061/1][main:136] -> stage #3 changed commit success: /repo/split
[30061/1][endedlog:119] -> ended at 08/30/18-06:16PM
MIT