Difference between revisions of "Repo.php"

From Wiki4Intranet
Jump to: navigation, search
Line 1: Line 1:
 
'''repo.php''' — скрипт обновления/установки, созданный нами и применяемый в [[Mediawiki4Intranet]].
 
'''repo.php''' — скрипт обновления/установки, созданный нами и применяемый в [[Mediawiki4Intranet]].
 
== Зачем нужен собственный скрипт? ==
 
 
Теоретически, вместо него можно было бы использовать просто подмодули Git’а (git submodules), но у них есть определённые минусы:
 
# Когда модулей под сотню — они '''медленные''', ибо:
 
#* Не умеют делать shallow клоны, всегда клонируют модули полностью.
 
#* Не поддерживают параллельное обновление.
 
# Сабмодули не могут работать с типичным расположением кода MediaWiki ''(если не клонировать репозиторий ядра)'', ибо:
 
#* Нельзя создать репозиторий, корень которого был бы submodule’ем.
 
#* Внутрь одного модуля нельзя поместить другой, не трогая его репозиторий.
 
#* Следовательно, репозиторий сборки должен являться клоном core с расширениями, подключёнными сабмодулями в <tt>extensions/ExtensionName</tt>. Изменения ядра в таком случае будут перемешиваться с изменениями модулей.
 
#: А это неудобно, так как хочется отделить репозиторий «сборки» от кода и дать возможность легко клонировать сборки, создавать свои сборки, дополненные какими-то расширениями и т. п.
 
#: Разве что можно было уйти от стандартного MediaWikовского расположения кода и поместить core в отдельную подпапку.
 
# Есть различные неудобства и недостатки функционала:
 
#* В .gitmodules нельзя указать желаемые ветки модулей (например, «хочу ParserFunctions REL1_20»). Опять-таки предполагается, что за версией модуля разработчик следит сам.
 
#* Переключать один и тот же модуль между разными репозиториями нужно руками — например, <tt>Wikimedia &rarr; наш_Github</tt> или <tt>наш_Github &rarr; ваш_форк</tt>.
 
#* git archive не работает с сабмодулями — если хочется распространять архив с кодом всей сборки, нужно писать отдельный скрипт.
 
#* Не поддерживаются различные способы доступа к одному репозиторию, например http на чтение для всех и ssh на запись для разработчиков.
 
#: То есть, если хочется нормально push’ить с использованием ssh-ключа, то нужно заставлять '''всех''' клонировать всё исключительно по ssh.
 
#* В различных ситуациях встречаются различные глюки. Например, «You are on a branch yet to be born» после неудачной попытки добавить submodule.
 
 
Часть этих проблем можно решить с помощью хелперов или bash-скриптов, однако мы решили сразу написать цельный инструмент.
 
  
 
== Возможности repo.php ==
 
== Возможности repo.php ==
Line 28: Line 6:
 
* Поддержка shallow checkout, «быстрых» рабочих копий для установки (method=ro) и «медленных» для разработки (method=rw)
 
* Поддержка shallow checkout, «быстрых» рабочих копий для установки (method=ro) и «медленных» для разработки (method=rw)
 
* Быстрое обновление установленного кода на основе файла индекса, содержащего хеши ревизий
 
* Быстрое обновление установленного кода на основе файла индекса, содержащего хеши ревизий
* Полное обновление всех модулей (что-то вроде git submodule foreach 'git pull')
+
* Полное обновление всех модулей (что-то вроде <tt>git submodule foreach 'git pull'</tt>)
 
* Параллельное обновление с красивым одновременным выводом состояния на экран с помощью escape-последовательностей (естественно, UNIX only)
 
* Параллельное обновление с красивым одновременным выводом состояния на экран с помощью escape-последовательностей (естественно, UNIX only)
 
* Поддержка произвольного расположения вытаскиваемых рабочих копий (в том числе друг внутри друга)
 
* Поддержка произвольного расположения вытаскиваемых рабочих копий (в том числе друг внутри друга)
 
* Создание архива с полным кодом сборки
 
* Создание архива с полным кодом сборки
 
* Автоматическое переключение между разными репозиториями одного модуля
 
* Автоматическое переключение между разными репозиториями одного модуля
* Возможность легкого добавления поддержки нужных систем контроля версий (которая, правда, пока что не пригодилась)
+
* Возможность легкого добавления поддержки любых нужных систем контроля версий (которая, правда, пока что не пригодилась)
  
 
== Системные требования ==
 
== Системные требования ==
  
* PHP 5.3 или новее
+
* PHP 5.3 или новее.
* Нормальная система (не винда) — Linux, FreeBSD или что-то подобное. На винде тоже может работать, но, во-первых, медленно (ибо не поддерживается pcntl => невозможно запускать команды параллельно), а во-вторых, никто эту работу не тестировал и вполне вероятно, что отвалится что-то ещё.
+
* Консольный Git-клиент, прописанный в пути.
* Расширение pcntl
+
* Нормальная система (не винда) — Linux, FreeBSD или что-то подобное. На винде тоже может работать, но, во-первых, медленно (ибо не поддерживается pcntl => невозможно запускать команды параллельно), а во-вторых, никто эту работу не тестировал и вполне вероятно, что отвалится что-то ещё. Возможно, будет нормально работать под Cygwin.
 +
* Расширение [http://www.php.net/manual/ru/book.pcntl.php pcntl].
  
 
== Как работать с repo.php ==
 
== Как работать с repo.php ==
Line 46: Line 25:
  
 
* Если хотим коммитить — прописываем публичный ssh-ключ для github’а
 
* Если хотим коммитить — прописываем публичный ssh-ключ для github’а
* Клонируем головной репозиторий (configs)
+
* Клонируем головной репозиторий ([https://github.com/mediawiki4intranet/configs configs])
 
* В нём запускаем <tt>php repo.php install mediawiki4intranet rw</tt>. mediawiki4intranet — имя сборки, rw — тип установки (если хотите коммитить — то rw, если нет — ro)
 
* В нём запускаем <tt>php repo.php install mediawiki4intranet rw</tt>. mediawiki4intranet — имя сборки, rw — тип установки (если хотите коммитить — то rw, если нет — ro)
  
Line 63: Line 42:
 
=== Добавление модуля ===
 
=== Добавление модуля ===
  
* Создаём удалённый репозиторий (на стороне github’а или другого сервера), или убеждаемся в том, что он уже создан до нас
+
* Создаём репозиторий для модуля на стороне github’а или другого сервера (или убеждаемся в том, что он уже создан до нас)
 
* По аналогии добавляем описание модуля в mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
 
* По аналогии добавляем описание модуля в mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
 
* <tt>php repo.php update</tt>
 
* <tt>php repo.php update</tt>
Line 72: Line 51:
 
* Удаляем модуль из mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
 
* Удаляем модуль из mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
 
* Коммитим и push’им configs
 
* Коммитим и push’им configs
 +
 +
=== Создание своей сборки на основе нашей ===
 +
 +
* Клонируем наш репозиторий configs к себе — например, путём нажатия «Clone» на github. Либо — на любом другом сервере путём создания репозитория + клонирования нашего к себе на компьютер + push’а из локального репозитория в свой новый.
 +
* Удостовериваемся, что команда git remote -v show выводит ваш новый репозиторий (а не наш configs).
 +
* Создаём в новом configs '''собственный''' файл описания сборки — mediawiki4fuhrer.ini, и в нём пишем:
 +
<pre>
 +
; включаем нашу сборку
 +
[_params]
 +
include = mediawiki4intranet
 +
 +
; добавляем или переопределяем часть расширений
 +
[extensions/MySuperExtension]
 +
repo = github:viewfuhrer/MySuperExtension
 +
branch = master
 +
 +
; и так далее...
 +
</pre>
 +
* Скорее всего, вам потребуется версионировать и собственный вариант конфигурации (*Settings.php). Тут желательно тоже не трогать наш BaseSettings.php, а создать свой, включающий наш, и добавить его git add.
 +
 +
Далее внутри вашего нового configs запускаем команды:
 +
<code-bash>
 +
php repo.php update
 +
git add mediawiki4fuhrer.ini mediawiki4fuhrer-index.ini
 +
git commit -m 'Создал свою сборку'
 +
git push
 +
</code-bash>
 +
 +
После этого вы можете работать со своей сборкой так же, как и с нашей (обновляя/добавляя расширения). Единственное, что вы (пока что) не сможете — это исключать из сборки расширения, включённые нами (хотя если сильно хочется — можно сделать для этого расширения репозиторий-заглушку с 1 пустым PHP файлом расширения).
 +
 +
{{NoteBox|Однако, для того, чтобы наши обновления попадали к вам, вам нужно время от времени сливать наши изменения со своими. То есть, время от времени вызывать команду {{cmd|git pull https://github.com/mediawiki4intranet/configs}}.}}
  
 
=== Troubleshooting ===
 
=== Troubleshooting ===
  
Если что-то пошло не так — можно указать параметр '-j 1': <tt>php repo.php -j 1 update</tt>. Команды будут запущены последовательно и вы увидите полный вывод git’а, на основании которого можно попытаться понять, что произошло.
+
Если что-то пошло не так — с недавних пор repo.php должен вывести полный текст всех ошибок. Если этого не произошло — можно указать параметр '-j 1': <tt>php repo.php -j 1 update</tt>. Команды будут запущены последовательно и вы увидите полный вывод всех вызываемых команд.
 +
 
 +
== Зачем нужен собственный скрипт? ==
 +
 
 +
Теоретически, вместо repo.php можно было бы просто использовать подмодули Git’а (git submodules), но у них есть определённые минусы:
 +
# Когда модулей под сотню — они '''медленные''', ибо:
 +
#* Не умеют делать shallow клоны, всегда клонируют модули полностью.
 +
#* Не поддерживают параллельное обновление.
 +
# Сабмодули не могут работать с типичным расположением кода MediaWiki ''(если не клонировать репозиторий ядра)'', ибо:
 +
#* Нельзя создать репозиторий, корень которого был бы submodule’ем.
 +
#* Внутрь одного модуля нельзя поместить другой, не трогая его репозиторий.
 +
#* Следовательно, репозиторий сборки должен являться клоном core с расширениями, подключёнными сабмодулями в <tt>extensions/ExtensionName</tt>. Изменения ядра в таком случае будут перемешиваться с изменениями модулей. Так, кстати, и делает Wikimedia Foundation в своей сборке.
 +
#: Но это неудобно, так как хочется отделить репозиторий «сборки» от кода и дать возможность легко клонировать сборки, создавать свои сборки, дополненные какими-то расширениями и т. п.
 +
#: Разве что можно было уйти от стандартного MediaWiki’овского расположения кода и поместить core в отдельную подпапку, а extensions — вне core.
 +
# Есть различные неудобства и недостатки функционала:
 +
#* В .gitmodules нельзя указать желаемые ветки модулей (например, «хочу ParserFunctions REL1_20»). Опять-таки предполагается, что за версией модуля разработчик следит сам.
 +
#* Переключать один и тот же модуль между разными репозиториями нужно руками — например, <tt>Wikimedia &rarr; наш_Github</tt> или <tt>наш_Github &rarr; ваш_форк</tt>.
 +
#* git archive не работает с сабмодулями — если хочется распространять архив с кодом всей сборки, нужно писать отдельный скрипт.
 +
#* Не поддерживаются различные способы доступа к одному репозиторию, например http на чтение для всех и ssh на запись для разработчиков.
 +
#: То есть, если хочется нормально push’ить с использованием ssh-ключа, то нужно заставлять '''всех''' клонировать всё исключительно по ssh (ссылка-то прямо в репозитории прописывается).
 +
#* Встречаются различные глюки. Например, «You are on a branch yet to be born» после неудачной попытки добавить submodule.
 +
 
 +
Часть этих проблем можно было решить с помощью хелперов или bash-скриптов, однако мы решили сразу написать цельный инструмент.
  
 
== TODO ==
 
== TODO ==

Revision as of 17:36, 4 September 2013

repo.php — скрипт обновления/установки, созданный нами и применяемый в Mediawiki4Intranet.

Возможности repo.php

  • Установка «сборок» на основе их описаний в ini-файлах, содержащих адреса репозиториев и имена требуемых веток
  • Поддержка shallow checkout, «быстрых» рабочих копий для установки (method=ro) и «медленных» для разработки (method=rw)
  • Быстрое обновление установленного кода на основе файла индекса, содержащего хеши ревизий
  • Полное обновление всех модулей (что-то вроде git submodule foreach 'git pull')
  • Параллельное обновление с красивым одновременным выводом состояния на экран с помощью escape-последовательностей (естественно, UNIX only)
  • Поддержка произвольного расположения вытаскиваемых рабочих копий (в том числе друг внутри друга)
  • Создание архива с полным кодом сборки
  • Автоматическое переключение между разными репозиториями одного модуля
  • Возможность легкого добавления поддержки любых нужных систем контроля версий (которая, правда, пока что не пригодилась)

Системные требования

  • PHP 5.3 или новее.
  • Консольный Git-клиент, прописанный в пути.
  • Нормальная система (не винда) — Linux, FreeBSD или что-то подобное. На винде тоже может работать, но, во-первых, медленно (ибо не поддерживается pcntl => невозможно запускать команды параллельно), а во-вторых, никто эту работу не тестировал и вполне вероятно, что отвалится что-то ещё. Возможно, будет нормально работать под Cygwin.
  • Расширение pcntl.

Как работать с repo.php

Установка сборки

  • Если хотим коммитить — прописываем публичный ssh-ключ для github’а
  • Клонируем головной репозиторий (configs)
  • В нём запускаем php repo.php install mediawiki4intranet rw. mediawiki4intranet — имя сборки, rw — тип установки (если хотите коммитить — то rw, если нет — ro)

Обновление сборки

  • php repo.php update

Коммит модуля

  • Вносим правки
  • Коммитим и push’им их git’ом, как обычно
  • Идём в configs
  • php repo.php update
  • Коммитим и push’им configs

Добавление модуля

  • Создаём репозиторий для модуля на стороне github’а или другого сервера (или убеждаемся в том, что он уже создан до нас)
  • По аналогии добавляем описание модуля в mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
  • php repo.php update
  • Коммитим и push’им configs

Удаление модуля

  • Удаляем модуль из mediawiki4intranet.ini (ИМЯ_СБОРКИ.ini)
  • Коммитим и push’им configs

Создание своей сборки на основе нашей

  • Клонируем наш репозиторий configs к себе — например, путём нажатия «Clone» на github. Либо — на любом другом сервере путём создания репозитория + клонирования нашего к себе на компьютер + push’а из локального репозитория в свой новый.
  • Удостовериваемся, что команда git remote -v show выводит ваш новый репозиторий (а не наш configs).
  • Создаём в новом configs собственный файл описания сборки — mediawiki4fuhrer.ini, и в нём пишем:
; включаем нашу сборку
[_params]
include = mediawiki4intranet

; добавляем или переопределяем часть расширений
[extensions/MySuperExtension]
repo = github:viewfuhrer/MySuperExtension
branch = master

; и так далее...
  • Скорее всего, вам потребуется версионировать и собственный вариант конфигурации (*Settings.php). Тут желательно тоже не трогать наш BaseSettings.php, а создать свой, включающий наш, и добавить его git add.

Далее внутри вашего нового configs запускаем команды:

php repo.php update
git add mediawiki4fuhrer.ini mediawiki4fuhrer-index.ini
git commit -m 'Создал свою сборку'
git push

После этого вы можете работать со своей сборкой так же, как и с нашей (обновляя/добавляя расширения). Единственное, что вы (пока что) не сможете — это исключать из сборки расширения, включённые нами (хотя если сильно хочется — можно сделать для этого расширения репозиторий-заглушку с 1 пустым PHP файлом расширения).

Note.svg Однако, для того, чтобы наши обновления попадали к вам, вам нужно время от времени сливать наши изменения со своими. То есть, время от времени вызывать команду git pull https://github.com/mediawiki4intranet/configs.

Troubleshooting

Если что-то пошло не так — с недавних пор repo.php должен вывести полный текст всех ошибок. Если этого не произошло — можно указать параметр '-j 1': php repo.php -j 1 update. Команды будут запущены последовательно и вы увидите полный вывод всех вызываемых команд.

Зачем нужен собственный скрипт?

Теоретически, вместо repo.php можно было бы просто использовать подмодули Git’а (git submodules), но у них есть определённые минусы:

  1. Когда модулей под сотню — они медленные, ибо:
    • Не умеют делать shallow клоны, всегда клонируют модули полностью.
    • Не поддерживают параллельное обновление.
  2. Сабмодули не могут работать с типичным расположением кода MediaWiki (если не клонировать репозиторий ядра), ибо:
    • Нельзя создать репозиторий, корень которого был бы submodule’ем.
    • Внутрь одного модуля нельзя поместить другой, не трогая его репозиторий.
    • Следовательно, репозиторий сборки должен являться клоном core с расширениями, подключёнными сабмодулями в extensions/ExtensionName. Изменения ядра в таком случае будут перемешиваться с изменениями модулей. Так, кстати, и делает Wikimedia Foundation в своей сборке.
    Но это неудобно, так как хочется отделить репозиторий «сборки» от кода и дать возможность легко клонировать сборки, создавать свои сборки, дополненные какими-то расширениями и т. п.
    Разве что можно было уйти от стандартного MediaWiki’овского расположения кода и поместить core в отдельную подпапку, а extensions — вне core.
  3. Есть различные неудобства и недостатки функционала:
    • В .gitmodules нельзя указать желаемые ветки модулей (например, «хочу ParserFunctions REL1_20»). Опять-таки предполагается, что за версией модуля разработчик следит сам.
    • Переключать один и тот же модуль между разными репозиториями нужно руками — например, Wikimedia → наш_Github или наш_Github → ваш_форк.
    • git archive не работает с сабмодулями — если хочется распространять архив с кодом всей сборки, нужно писать отдельный скрипт.
    • Не поддерживаются различные способы доступа к одному репозиторию, например http на чтение для всех и ssh на запись для разработчиков.
    То есть, если хочется нормально push’ить с использованием ssh-ключа, то нужно заставлять всех клонировать всё исключительно по ssh (ссылка-то прямо в репозитории прописывается).
    • Встречаются различные глюки. Например, «You are on a branch yet to be born» после неудачной попытки добавить submodule.

Часть этих проблем можно было решить с помощью хелперов или bash-скриптов, однако мы решили сразу написать цельный инструмент.

TODO

  • Задание дополнительных remotes для устанавливаемых репозиториев. Например, 'wikimedia' для наших форков расширений.
  • Более гибкое задание readonly/readwrite — возможность клонирования части репозиториев как readonly, а части — как readwrite. Либо, возможность клонирования по https, а push’а по ssh. Возможно, через те же remotes.