Контроль версий в Subversion

При включенном режиме разработки в файловой системе механизм интеграции с SVN отключен. Встроенными средствами можно только установить либо обновить пакеты из хранилища SVN. Поэтому рекомендуется создавать пакет с помощью встроенных средств, а привязывать его к хранилищу — с помощью сторонних утилит, например, TortoiseSVN.

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

1. Создать пакет 

Чтобы создать пользовательский пакет:

1. Перейдите в дизайнер системы по кнопке .
2. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
3. В области работы с пакетами нажмите кнопку .
4. Заполните свойства пакета:
   
   • Название (Name) — "sdkTestPackage".

   • Хранилище системы контроля версий (Version control system repository) — "SDKPackages".

     Если заполнить поле Хранилище системы контроля версий (Version control system repository), то пакет будет привязан к хранилищу. При включенном режиме разработки в файловой системе каталог с названием, соответствующим пакету, необходимо вручную добавить в хранилище.

     Если не заполнять поле Хранилище системы контроля версий (Version control system repository), то пакет не будет привязан к хранилищу. Вести версионную разработку этого пакета можно будет только подключив его вручную из файловой системы.

   • Версия (Version) — "7.18.0".

   Важно. Название репозитория в свойствах пакета указывает только на то, что каталог для пакета будет создан сторонними средствами в этом репозитории. Это позволит в дальнейшем выполнять обновление пакета из раздела Конфигурация (Configuration).

5. Нажмите кнопку Создать и добавить зависимости (Create and add dependencies) и установите зависимости пакета.

2. Выгрузить пакет в файловую систему 

Чтобы выгрузить пакет в файловую систему:

1. Настройте Creatio для работы в файловой системе. Настройка описана в статье Внешние IDE.
2. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Выгрузить все пакеты в файловую систему (Download packages to file system).
   

В результате все пакеты будут выгружены по пути ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg в каталог с соответствующим названием пакета.

3. Создать каталоги для пакета в хранилище SVN 

Чтобы создать каталоги для пакета в хранилище SVN необходимо использовать клиентское приложение для работы с SVN (например, TortoiseSvn).

Чтобы создать каталоги для пакета в хранилище SVN:

1. Перейдите в репозиторий, указанный в свойствах пакета.
2. В репозитории создайте каталог, название которого совпадает с названием созданного в приложении пакета. В нашем примере это sdkTestPackage.
   
3. В созданном каталоге создайте подкаталоги branches и tags.
4. В каталоге branches создайте каталог, название которого совпадает с номером версии пакета — 7.18.0.
   

4. Создать рабочую копию версионной ветки пакета 

Чтобы создать рабочую копию версионной ветки пакета:

1. Выгрузите (команда SVN Checkout...) созданный на предыдущем шаге каталог из хранилища в каталог пакета в файловой системе. В нашем примере это каталог 7.18.0.
   
2. Подтвердите выгрузку в существующий каталог.
   

В результате каталог пакета в файловой системе ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkTestPackage будет связан с веткой версии 7.18.0 пакета в хранилище.

5. Зафиксировать пакет в хранилище 

Чтобы зафиксировать пакет в хранилище:

1. Добавьте (команда SVN Commit) в хранилище содержимое каталога ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkTestPackage.
   
2. Выполните фиксацию каталога в хранилище.
   

В пакете содержится функциональность детали с редактируемым реестром.

Creatio предоставляет возможность установить существующий пакет из SVN в режиме разработки в файловой системе автоматически и вручную.

Последовательность действий при ручной установке пакета:

1. Установить пакет в файловую систему.
2. Установить пакет в приложение.
3. Выполнить генерацию исходных кодов.
4. Скомпилировать изменения.
5. Обновить структуру базы данных.
6. Установить SQL-сценарии и привязанные данные (опционально).

Последовательность действий при автоматической установке пакета:

1. Включить автоматическое применение изменений.
2. Установить пакет в файловую систему.
3. Установить пакет в приложение.

Вручную установить пакет из SVN в режиме разработки в файловой системе 

1. Установить пакет в файловую систему 

Чтобы установить пакет в файловую систему:

1. В каталоге приложения ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg создайте каталог, название которого совпадает с названием пакета.
2. Выгрузите (команда SVN Checkout...) созданный на предыдущем шаге каталог из хранилища в каталог пакета в файловой системе.
3. Укажите адрес хранилища, по которому размещено содержимое пакета, и каталог для выгрузки содержимого пакета.
   

Название каталога для выгрузки содержимого пакета должно совпадать с названием пакета.

После выгрузки в каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg будет создана рабочая копия пакета.

2. Установить пакет в приложение 

Чтобы установить пакет в приложение:

1. Перейдите в дизайнер системы по кнопке .
2. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
3. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Обновить пакеты из файловой системы (Update packages from file system).
   

В результате пакет будет добавлен в приложение.

Информационное окно статуса загрузки пакета в приложение

Пакет в области работы с пакетами

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

3. Выполнить генерацию исходных кодов 

Чтобы выполнить генерацию исходных кодов:

1. На панели инструментов в группе действий Исходный код (Source code) выберите Сгенерировать для требующих генерации (Generate where it is needed).
   

4. Скомпилировать изменения 

Чтобы скомпилировать изменения, на панели инструментов нажмите Компилировать (Compile).

Необходимость обновления структуры базы данных, установки SQL-скриптов и привязанных данных отображается в колонке Статус (Status) рабочей области раздела Конфигурация (Configuration).

5. Обновить структуру базы данных 

Чтобы обновить структуру базы данных, на панели инструментов в группе действий Актуализировать элементы (Actualize items) выберите Обновить структуру БД для требующих обновления (Update DB structure where it is needed).

6. Установить SQL-сценарии и привязанные данные (опционально) 

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

После установки в приложении станет доступна реализованная в пакете функциональность. В нашем примере это функциональность детали с редактируемым реестром.

Для отображения примененных изменений может понадобиться обновление страницы с очисткой кэша.

Автоматически установить пакет из SVN в режиме разработки в файловой системе 

1. Включить автоматическое применение изменений 

Чтобы включить автоматическое применение изменений, в файле ..\Terrasoft.WebApp\Web.config установите значение true для ключей элемента <appSettings>:

• AutoUpdateOnCommit — ключ отвечает за автоматическое обновление пакетов из хранилища SVN перед их заливкой. Если для этого ключа установлено значение false, то перед заливкой в хранилище SVN приложение предупредит пользователя о необходимости обновления, если схемы пакета были изменены.
• AutoUpdateDBStructure — ключ отвечает за автоматическое обновление структуры базы данных.
• AutoInstallSqlScript — ключ отвечает за автоматическую установку SQL-сценариев.
• AutoInstallPackageData — ключ отвечает за установку привязанных данных.

<appSettings>
    ...
    <add key="AutoUpdateOnCommit" value="true" />
    <add key="AutoUpdateDBStructure" value="true" />
    <add key="AutoInstallSqlScript" value="true" />
    <add key="AutoInstallPackageData" value="true" />
</appSettings>

Затем выполните шаги 1—2 последовательность действий пункта Вручную установить пакет из SVN в режиме разработки в файловой системе.

Настроить взаимодействие с хранилищем SVN (опционально) 

Creatio позволяет настроить взаимодействие с хранилищем SVN как из раздела Конфигурация (Configuration), так и из файловой системы.

Чтобы настроить взаимодействие с хранилищем SVN:

1. Перейдите в дизайнер системы по кнопке .
2. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
3. Установите пакет из хранилища SVN. Подробная инструкция содержится в статье Контроль версий в Creatio IDE.
4. Выгрузите пакет в файловую систему. Подробная инструкция содержится в статье Настроить Creatio для работы в файловой системе.

Затем выполните шаги 3—6 последовательность действий пункта Вручную установить пакет из SVN в режиме разработки в файловой системе.

Может возникнуть задача, когда пользователю необходимо привязать к хранилищу пакет с файловой системы. Выполнить эту привязку можно только в on-site приложении Creatio. После привязки пакета к SVN в файловой системе его можно установить, используя встроенные средства Creatio.

1. Выгрузить пакет в файловую систему 

Чтобы выгрузить пакет в файловую систему:

1. Настройте Creatio для работы в файловой системе. Настройка описана в статье Внешние IDE.
2. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Выгрузить все пакеты в файловую систему (Download packages to file system).
   

В результате все пакеты будут выгружены по пути ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg в каталог с соответствующим названием пакета.

2. Создать каталоги для пакета в хранилище SVN 

Чтобы создать каталоги для пакета в хранилище SVN необходимо использовать клиентское приложение для работы с SVN (например, TortoiseSvn).

Чтобы создать каталоги для пакета в хранилище SVN:

1. Перейдите в репозиторий, указанный в свойствах пакета.
2. В репозитории создайте каталог, название которого совпадает с названием созданного в приложении пакета. В нашем примере это sdkUnboundPackage.
   
3. В созданном каталоге создайте подкаталоги branches и tags.
4. В каталоге branches создайте каталог, название которого совпадает с номером версии пакета — 7.18.0.
   

3. Создать рабочую копию версионной ветки пакета 

Чтобы создать рабочую копию версионной ветки пакета:

1. Выгрузите (команда SVN Checkout...) созданный на предыдущем шаге каталог из хранилища в каталог пакета в файловой системе. В нашем примере это каталог 7.18.0.
   
2. Подтвердите выгрузку в существующий каталог.
   

В результате каталог пакета в файловой системе ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkUnboundPackage будет связан с веткой версии 7.18.0 пакета в хранилище.

4. Зафиксировать в хранилище каталог пакета 

Чтобы зафиксировать в хранилище каталог пакета:

1. Добавьте в хранилище содержимое каталога ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkUnboundPackage.
   
2. Выполните фиксацию каталога в хранилище.
   

1. Подключите к приложению хранилище SVN 

Если хранилище SVN подключено к приложению, то перейдите к следующему шагу.

Чтобы подключить к приложению хранилище SVN:

1. Перейдите в дизайнер системы по кнопке .
2. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
3. На панели инструментов в группе действий Хранилища SVN (SVN repositories) выберите Открыть список хранилищ (Open list of repositories).
   
4. Нажмите Добавить (Add) и добавьте репозиторий. В нашем примере это .../SDKPackages.
   
5. Нажмите Аутентификация (Authenticate) и выполните аутентификацию.

2. Привязать хранилище SVN к пакету 

Чтобы привязать хранилище SVN к пакету:

1. Перейдите в базу данных приложения.
2. В базе данных выполните SQL-запрос.
   Пример SQL-запроса

   UPDATE SysPackage 
   SET 
       [SysRepositoryId] = 
       (
           select top 1 Id from SysRepository
           where Name = 'SDKPackages'-- Название хранилища.
       )
   where [Name]='sdkUnboundPackage'-- Название пользовательского пакета.
   
   

   Этот запрос позволяет:

   • Из таблицы [SysRepository] считать идентификатор записи, содержащей адрес хранилища SVN.
   • Добавить полученный идентификатор в колонку [SysRepositoryId] записи, которая содержит имя не привязанного к хранилищу SVN пакета, таблицы [SysPackage].

Чтобы изменения применились в приложении, необходимо выйти из приложения и зайти повторно.

3. Выгрузить пакет в файловую систему 

Чтобы выгрузить пакет в файловую систему:

1. Настройте Creatio для работы в файловой системе. Настройка описана в статье Внешние IDE.
2. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Выгрузить все пакеты в файловую систему (Download packages to file system).
   

В результате все пакеты будут выгружены по пути ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg в каталог с соответствующим названием пакета.

1. Обновить пакет из хранилища SVN 

Для получения последней ревизии пакета необходимо использовать клиентское приложение для работы с SVN (например, TortoiseSvn).

Чтобы обновить пакет из хранилища SVN:

1. В каталоге ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg выберите необходимый пакет. В нашем примере это sdkPackageInFileSystem.
2. Обновите пакет (команда SVN Update).

   После выполнения команды будут обновлены дата редактирования пакета в файле дескриптора пакета descriptor.json и исходный код схемы типа Исходный код (Source code) UsrGreetingService.

   Схема UsrGreetingService

   namespace Terrasoft.Configuration
   {
       using System.ServiceModel;
       using System.ServiceModel.Activation;
       using System.ServiceModel.Web;
       [ServiceContract]
       [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
       public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
       {
           [OperationContract]
           [WebInvoke(Method = "GET", UriTemplate = "Hello")]
           public string TestHello()
           {
               return "Hello!";
           }
       }
   }
   

3. Перейдите в дизайнер системы по кнопке .
4. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
5. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Обновить пакеты из файловой системы (Update packages from file system).
   
6. Если были изменены схемы объектов или схемы исходного кода, то для применения изменений также необходимо выполнить шаги 3—6 статьи Установить пакет из SVN в режиме разработки в файловой системе.

2. Изменить содержимое пакета 

Чтобы изменить содержимое пакета, добавьте в схему типа Исходный код (Source code) UsrGreetingServiceметод TestHelloWorld().

namespace Terrasoft.Configuration
{
    using System.ServiceModel;
    using System.ServiceModel.Activation;
    using System.ServiceModel.Web;
    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
    {
        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "Hello")]
        public string TestHello()
        {
            return "Hello!";
        }

        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "HelloWorld")]
        public string TestHelloWorld()
        {
            return "Hello world!";
        }
    }
}

3. Зафиксировать пакет в хранилище 

Чтобы зафиксировать пакет в хранилище:

1. В каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg выберите необходимый пакет. В нашем примере это sdkPackageInFileSystem.
2. Выполните фиксацию (команда SVN Commit) каталога в хранилище.
   

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

Общие рекомендации:

• В режиме разработки в файловой системе работать с хранилищем SVN следует только из файловой системы.
• В режиме разработки с помощью встроенных средств работать с SVN нужно только встроенными средствами раздела Конфигурация (Configuration).

1. Задать путь к каталогу для рабочих копий пакетов 

В режиме разработки в файловой системе после выполнения действия Выгрузить пакеты в файловую систему (Download packages to file system) все пользовательские пакеты будут выгружены в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg. При этом содержимое пользовательского пакета, выгруженное в файловую систему, не будет привязано к хранилищу SVN, даже если пакет был привязан к хранилищу в разделе Конфигурация (Configuration).

Если при создании пакета заполнить поле Хранилище системы контроля версий (Version control system repository) с помощью встроенных средств, то пакет будет привязан к хранилищу SVN. При этом в файловой системе будет создана рабочая копия пакета. Путь к каталогу, в котором создаются рабочие копии пакетов, задается в файле ConnectionStrings.config с помощью настройки defPackagesWorkingCopyPath. Если в настройке defPackagesWorkingCopyPath указать путь к каталогу ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg, то после выгрузки пакета в файловую систему он будет автоматически привязан к нужному хранилищу SVN.

Чтобы задать путь к каталогу для рабочих копий пакетов, в настройке defPackagesWorkingCopyPath файла ConnectionStrings.config укажите полный путь к каталогу ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg.

<?xml version="1.0" encoding="utf-8"?>
<connectionStrings>
  ...
  <add name="defPackagesWorkingCopyPath" connectionString="C:\creatio\Terrasoft.WebApp\Terrasoft.Configuration\Pkg"/>
  ...
</connectionStrings>

Это изменение позволяет совместить каталог, в котором содержатся рабочие копии пользовательских пакетов, с каталогом, в который выгружаются пакеты в режиме разработки в файловой системе.

2. Создать пакет 

Чтобы создать пользовательский пакет:

1. Перейдите в дизайнер системы по кнопке .
2. В блоке Конфигурирование разработчиком (Admin area) перейдите по ссылке Управление конфигурацией (Advanced settings).
3. В области работы с пакетами нажмите кнопку .
4. Заполните свойства пакета:
   
   • Название (Name) — "sdkPackageForFileSystem".
   • Хранилище системы контроля версий (Version control system repository) — "SDKPackages".
   • Версия (Version) — "7.18.0".
5. Нажмите кнопку Создать и добавить зависимости (Create and add dependencies) и установите зависимости пакета.

В результате пакет будет автоматически зафиксирован в SVN, а в каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg будет создана рабочая копия пакета.

3. Выгрузить пакет в файловую систему 

Чтобы выгрузить пакет в файловую систему:

1. Настройте Creatio для работы в файловой системе. Настройка описана в статье Внешние IDE.
2. На панели инструментов в группе действий Разработка в файловой системе (File system development mode) выберите Выгрузить все пакеты в файловую систему (Download packages to file system).
   

В результате все пакеты будут выгружены по пути ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg в каталог с соответствующим названием пакета.

4. Зафиксировать пакет в хранилище 

Чтобы зафиксировать пакет в хранилище:

1. Добавьте (команда SVN Commit) в хранилище содержимое каталога ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkPackageForFileSystem.
   
2. Выполните фиксацию каталога в хранилище.