Ревизионирование
Ревизионирование – это инструмент для управления изменениями в объектах системы. Он позволяет вносить правки безопасно, не затрагивая версию, которая уже используется в производственных процессах.
В системе всегда существует одна актуальная версия объекта. Когда требуется внести изменения, создается черновик – отдельная копия, недоступная другим пользователям. После завершения работы черновик публикуется и становится новой актуальной версией, а предыдущая сохраняется в истории.
Все предыдущие ревизии хранятся в системе и доступны для восстановления в любой момент.
Ревизионирование реализовано для следующих объектов:
Основные термины
Версия – зафиксированное состояние объекта, доступное для использования в системе. В каждый момент времени в системе существует только одна актуальная версия.
Ревизия – итерация внутри версии, отражающая внесенные изменения или доработки. Ревизии фиксируют историю изменений и позволяют вернуться к предыдущему состоянию объекта.
Версионирование – процесс управления версиями объекта: их создание, публикация, хранение и использование в системе.
Ревизионирование – инструмент для фиксации, хранения и восстановления ревизий.
Черновик – копия актуальной версии объекта, создаваемая при взятии ревизии в работу. Доступна только тому пользователю, который ее создал.
Статусы ревизий
Каждая ревизия находится в одном из трех статусов. Статус отображается в виде иконки рядом с названием ревизии в виджете.
| Иконка | Статус | Описание |
|---|---|---|
| В работе | Редактируемая ревизия. Пользователь может вносить изменения, оставлять комментарии и управлять черновиком | |
| Текущая | Актуальная версия объекта, которая используется в системе. Недоступна для редактирования | |
| Историческая | Ревизия, которая ранее была актуальной, но была заменена более новой версией. Хранится в системе для справки и может быть использована для отката |
Статусы меняются в следующем порядке:
В работе → Текущая → Историческая
При публикации ревизии со статусом В работе она становится Текущей, а предыдущая Текущая автоматически переходит в статус Историческая.
Виджет ревизионирования
При нажатии на кнопку Ревизионирование на форме записи открывается модальное окно.
В модальном окне отображается список всех ревизий объекта. Каждая ревизия показывается в виде отдельной строки с иконкой статуса и названием, которое генерируется автоматически.
Кнопки управления
| Кнопка | Описание | Когда активна |
|---|---|---|
| Создать | Создает новую ревизию со статусом В работе | Если нет ревизий со статусом В работе |
| Редактировать | Создает черновик и открывает его для редактирования | Если выбрана ревизия со статусом В работе и никто другой не редактирует ее |
| Зафиксировать | Завершает редактирование и открывает доступ другим пользователям | Если текущий пользователь нажал Редактировать для выбранной ревизии |
| Опубликовать | Публикует черновик как новую актуальную версию | Если текущий пользователь нажал Зафиксировать для выбранной ревизии |
| Создать копию | Создает новую ревизию на основе выбранной | Если выбрана Историческая ревизия |
| Удалить | Удаляет ревизию | Если выбрана ревизия со статусом В работе |
Комментарии к ревизии
При нажатии на название ревизии открывается модальное окно с комментарием.
Состав полей зависит от статуса ревизии:
- Ревизия со статусом В работе:
Историческая информация – комментарий из предыдущей версии. Недоступно для редактирования.
Актуальная информация – поле для нового комментария. Доступно для редактирования.
- Ревизия со статусом Текущая или Историческая:
Историческая информация – комментарий, оставленный при публикации. Недоступно для редактирования.
При публикации ревизии текст из поля Актуальная информация переносится в поле Историческая информация и заменяет предыдущий комментарий
Как работать с ревизиями
Создание и публикация ревизии
- Нажмите кнопку Ревизионирование на форме записи – откроется виджет со списком ревизий.
- Нажмите Создать – будет создана новая ревизия со статусом В работе.
- Выберите созданную ревизию и нажмите Редактировать. Система создаст черновик и автоматически перейдет на его форму.
- Внесите необходимые изменения и сохраните форму.
- Вернитесь к исходной записи, откройте виджет Ревизионирование и нажмите Зафиксировать.
- Нажмите Опубликовать – черновик станет новой актуальной версией записи.
После публикации ревизия становится недоступной для редактирования. Чтобы внести новые изменения, создайте следующую ревизию
Восстановление предыдущей ревизии
- Откройте виджет Ревизионирование и выберите историческую ревизию, к которой нужно вернуться.
- Нажмите Создать копию – будет создана новая ревизия на основе выбранной.
- Нажмите Редактировать – система создаст черновик на основе выбранной исторической ревизии.
- Внесите необходимые изменения и сохраните форму.
- Вернитесь к исходной записи, откройте виджет Ревизионирование и нажмите Зафиксировать.
- Нажмите опубликовать – ревизия станет новой актуальной версией записи.