Инструкция к приложению История внедрения в Git (Bxchanger)


Описание

Данное приложение не имеет платной версии

Помогает отслеживать историю изменений различных настроек портала.

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

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

Создайте отдельный приватный репозиторий в Git и привяжите его к приложению. После этого изменения будут выгружаться раз в день (около 03 часов ночи), создавая коммит в привязанном репозитории. Вы сможете увидеть, что изменялось, стандартная подсветка коммитов Git выделит зеленым добавленные настройки и красным — удаленные.

Если изменения не происходили, то коммит не будет создан.

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

Таким образом, с помощью приложения у вас будет копиться история, и вы сможете узнать, когда, к примеру, удалили какие-то права доступа, или добавили новые стадии сделок, и так далее. 


Инструкция

Настройки

Установите приложение на свой портал Битрикс24.

Настройки на стороне Git 

Зарегистрируйтесь на https://github.com/

Создайте там новый приватный репозиторий


Откройте настройки вашей учетной записи в Git (верхнее выпадающее меню) и идите по пути Settings -> Developer settings -> Personal access tokens. Вам требуется сгенерировать токен, с помощью котого будем подключать к Git приложение.


После того, как вы нажмете Generate new token, обязательно заполните поле Note и отметьте галочкой скоуп repo, затем сохраните токен. 

Внимание! Сгенерированный токен будет виден только на время, пока вы находитесь на странице свежесозданного токена. После того, как вы покинете эту страницу, вы не сможете вернуться и посмотреть токен снова. Поэтому рекомендуем сразу после генерации токена скопировать его и вставить в приложение. 

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

Настройки на стороне Битрикс24

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

Включите расширенный функционал, если хотите выгружать изменения, которые происходили в настройках "CRM - Права пользователей", "Бизнес Процессы", "Установленные приложения". Для активации потребуется ввести логин и пароль учетной записи в Битрикс24. 

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

Как работать с приложением

После того, как все было настроено, запустите выгрузку вручную. Самая первая выгрузка для вашего портала зафиксирует состояние портала на момент ее выполнения.

Все последующие выгрузки будут сохранять только изменения в настройках.

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

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

Раз в сутки приложение создает автоматический коммит в подключенный репозиторий, куда сохраняет историю изменений настроек на портале. Автоматический запуск происходит около 3 часов ночи.

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

Текущий список выгружаемых настроек:

  • CRM - Справочники
  • CRM - Валюта
  • CRM - Ставки НДС
  • Единицы измерения
  • Свойства товаров
  • Направления сделок
  • Шаблоны реквизитов

Расширенный режим: все перечисленное выше, +

  • Бизнес Процессы и Роботы
  • CRM - Права пользователей
  • Установленные приложения

В результате выгрузки (автоматической или ручной) в подключенном репозитории будет создан коммит с изменениями настроек на портале, которые произошли с момента последней выгрузки. Если изменений не было, то коммит создан не будет!

В самом приложении есть окно с историей коммитов, можно оттуда перейти на страницу коммита в Git по ссылкам. 


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

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

Например, написать: Добавлен Источник "Онлайн Магазин"; Удален Бизнес-Процесс "Тестовый 123"


На странице коммита в Git стандартная подсветка изменений покажет зеленым то, что было добавлено, и красным — что было удалено. 


22.06.21 Выгрузка списка администраторов портала

Летом 2021 года в приложении стал выгружаться список администраторов на портале. Теперь если он меняется, это сохраняется в Git.

Текущий список администраторов будет сохраняться в файл portal_admins_list.txt


Изменения списка будут отображаться так, как и любые другие: красным удаление, зеленым добавление.



На какие вопросы отвечает эта статья:

1. Сколько стоит платная версия приложения "История внедрения в Git"?

2. Где можно посмотреть инструкцию по приложению "История внедрения в Git"?

3. Как работать с приложением "История внедрения в Git"?

4. Есть ли видео-инструкция по работе с приложением "История внедрения в Git"?

5. Приложение "История внедрения в Git" платное?