Организация разработки

• Основные понятия
  • Решение
    • Системные требования
  • Дистрибутив сервера приложения
    • Системные требования
  • Модуль
    • Зависимости
    • Проектный модуль
  • Репозиторий библиотек
  • Комплект сборки
  • База данных
    • Системные требования
    • Конфигурация решения
    • Создание базы данных для разработки
    • Создание тестовой базы данных
    • Шаблон ландшафта
  • Файловое хранилище
• Проект
  • Структура проекта
  • Конфигурация проекта
    • Источники модуля
    • local
    • git
    • base
    • buildKit
    • Пример конфигурации
  • Конфигурация репозиториев
    • Работа в изолированной сети
  • Интеграция в vcs
    • Стратегии ветвления
  • Публикация решения
  • Публикация комплекта сборки
• Проектная разработка
  • Общие положения
    • Назначение раздела
    • Область применения
    • Связанные разделы документации
    • Основные термины
    • Общие принципы проектной разработки
      • Приоритет стандартной функциональности
      • Разделение типовой и проектной части
      • Сохраняемость при обновлениях
  • Выбор способа проектной доработки
    • Общая схема выбора
    • Когда использовать настройку через интерфейс
    • Когда использовать объектные и универсальные характеристики
    • Когда использовать код и ODM
    • Когда использовать JEXL
    • Когда использовать точку расширения
    • Когда использовать проектное переопределение
    • Когда создавать проектную копию типового объекта
    • Краткие примеры выбора способа реализации
  • Проектное именование
    • Связь с общими правилами именования
    • Проектный префикс
    • Именование проектных модулей
    • Именование проектных классов
    • Именование проектных коллекций
    • Именование проектных атрибутов
    • Именование проектных характеристик
    • Именование кодов проектных записей
    • Именование проектных выборок и отображений
    • Именование Api, Avi, Pkg и Lib
    • Именование наследующих файлов и проектных переопределений
      • Наследование базовой логики
      • Проектное переопределение
    • Именование проектных печатных форм
    • Именование проектных JEXL-скриптов
    • Именование универсальных справочников и интеграционных настроек
  • Атрибуты и модель данных
    • Общая позиция
    • Характеристика через интерфейс
    • Атрибут ODM через код
    • JSON-атрибуты и формат дат
    • Создание нового проектного класса
    • Выбор супертипа класса
    • Генерация кода
    • Запрет на ручное изменение БД
  • Расширения и переопределения
    • Точки расширения
    • Simple Extensions
    • Проектное переопределение
    • Проектные копии типовых объектов
    • Изменение базовых справочников
    • Риски обновлений
    • Что нельзя менять напрямую
  • Интерфейс, печатные формы и JEXL
    • Выборки и отображения
    • Вычисляемые поля
    • Универсальный фильтр
    • Печатные формы
    • Выбор типа шаблона
    • Версионирование печатных форм
    • JEXL-скрипты
    • Ограничения по JEXL
    • Доступность интерфейсных элементов
  • Поставка, тестирование и сопровождение
    • DataInstall и миграции
    • Требования к скриптам установки данных
    • Миграционные пакеты проектного модуля
    • Права доступа
    • Аудит
    • Система контроля версий
    • Ветки и ревью
    • Проверка производительности при ревью
    • Релиз
    • Минимальный набор проверок
    • Регрессионное тестирование
    • Документирование проектных изменений
    • Запрещенные практики
    • Чек-лист проектного разработчика
• Релизы
  • Решение
  • Конфигурация
  • Сервер приложения
  • Комплект сборки
  • Snapshot версия
  • Релиз прикладного модуля
    • Версия модуля
    • Типы релиза
      • Состав релиза
        • Схема базы данных модуля
        • Доменная схема
        • Расширенная схема
      • Поставочные данные модуля
      • Миграционные данные
    • Миграционные пакеты
      • Общие сведения
      • Порядок вызова
      • Миграционные задачи
        • UpTask
          • Простая задача
          • Задача с секцией orElse
          • Анонимная задача
          • Зависимости
          • Зависимости между модулями.
        • DownTask
    • Sql-скрипты миграции
      • Общие сведения
      • Описание файла скриптов
      • Пример файла скриптов
  • Инструкции
    • Создание задачи миграции
    • Создание SQL-скрипта миграции
    • Выпуск новой версии
    • Установка релиза
      • Алгоритм работы
      • Сброс состояния обновления
    • Создание нового тега
• Подход expand/contract при обновлении системы
  • Когда применяется expand/contract
  • Общая схема
  • Основные правила проектирования
  • Фаза 1 — expand
  • Подготовка данных между фазами
  • Проверка готовности перед фазой contract
  • Фаза 2 — contract
  • Способы проверки готовности данных
    • Автоматическая проверка при установке обновления
    • Проверка в прикладном коде
    • Ручная проверка перед установкой
    • Комбинированная проверка
  • Использование DataInstall при expand/contract
  • Пример
  • Недопустимые варианты
• Работа с Git
  • Введение
    • Предисловие
      • Назначение
      • Аудитория
      • Содержание
      • Предварительные требования
      • Git
        • Основные определения
      • Ключевые особенности
      • Взаимодействие с Git
      • Глоссарий (ключевые термины и концепции)
    • Установка и настройка
      • Установка Git в Windows
        • Способ 1: Установка с официального сайта
        • Способ 2: Установка через пакетный менеджер Winget
        • Установка Git в ОС семейства GNU/Linux (на примере ALT Linux)
        • Установка дополнительных инструментов (рекомендуемых)
      • Настройка Git
        • Настройка автора коммитов
        • Проверка конфигурации
    • Дополнительная документация
      • Основные материалы по системе управления версиями Git
      • Материалы по работе с командной строкой (Terminal/Shell)
      • Документация по интеграции Git со средами разработки (IDE) и редакторами кода
      • Дополнительные рекомендованные ресурсы
  • Основные понятия Git
    • Структура репозитория
      • Введение: что такое репозиторий Git
      • Логическая структура: состояния файлов
        • Рабочий процесс работы с состоянием файлов
          • Работа через командную строку (Terminal / CLI)
          • Работа через интегрированную среду разработки (IDE)
      • Физическая структура
        • Скрипты-хуки
        • Глобальные файлы исключений
        • База данных объектов objects/*
          • Объекты
        • Система ссылок
          • Указатели
          • Конфигурационные файлы
          • Прочие важные элементы
        • Логическая структура
    • Коммит
      • Правила наименования коммитов
      • Метаданные коммита
      • Основные свойства
        • 1. Неизменяемость
        • 2. Атомарность
        • 3. Ссылочная целостность
      • Коммит и ветвление
    • Ссылки
      • Тег
        • Типы тегов
      • Ветка
        • Особенности веток
        • Ветвление веток
        • HEAD и detached HEAD
    • Ветка
      • Правила наименования веток
      • Слияние веток
      • Типы слияния
        • Fast-Forward слияние
        • Recursive слияние (трехстороннее)
        • Слияние с отклонением fast-forward (–no-ff)
      • Процесс слияния
      • Стратегии слияния
      • Лучшие практики
      • Команды слияния
    • Merge request
      • Зачем он нужен
      • Процесс работы с Merge Request
        • Шаг 1: Подготовка перед созданием MR
        • Шаг 2: Создание Merge Request
        • Шаг 3: Ревью и процесс обсуждения
        • Шаг 4: Слияние (Merge)
        • Идеальный Merge Request
  • Устранение конфликтов слияния
    • Как Git сообщает о конфликте
    • Устранение конфликтов с помощью CLI
    • Устранение конфликта через веб-интерфейс GitLab
    • Устранение конфликтов с помощью IntelliJ IDEA
  • Ответы на частые вопросы
    • Примеры рабочих процессов
      • Разработка несрочного функционала или исправлений
      • Экстренные исправления (hotfix) или срочный функционал для релизной ветки
        • Копирование экстренных исправлений в основную ветку разработки
          • Копирование одиночного коммита
          • Перенос диапазона коммитов
      • Перенос изменений в релизную ветку через rebase
      • Актуализация долгосрочных веток
      • Организация совместной разработки
        • Создание индивидуальных веток
        • Синхронизация изменений
        • Интеграция изменений в основную ветку
  • Приложение
    • Global GitFlow
      • Рекомендации по настройке окружения
      • Основные ветки
      • Вспомогательные ветки
      • Тестирование веток
      • Процесс выпуска релизов
      • Организация разработки
      • Заключение
    • Выпуск релизов ядровых модулей
      • Версионирование релизов
      • Управление задачами через релизы в Support
      • Процесс выпуска релизов
        • Примеры жизненного цикла версии
      • Организация разработки ядровых модулей
      • Организация разработки прикладных модулей
      • Разработка кросс-модульных функциональностей
    • Выпуск тегов модулей ядра
      • Расписание
      • Подготовка
      • Процедура выпуска
      • Завершение выпуска
• Развёртывание рабочего места
  • Установка компонентов
    • Под Windows
      • Необходимые компоненты
      • Установка
    • Под Astra Linux
      • Необходимые компоненты
      • Установка
    • Под Alt Linux
      • Необходимые компоненты
      • Установка
  • Настройка проекта
    • Добавление проекта
    • Настройка проекта под Windows
    • Подключение к базе данных
• Подготовка и включение кросс-компиляции модуля для Scala 3
  • Общий порядок актуализации модуля
  • Порядок миграции модулей
  • Подготовка модуля к включению флага
    • 1. Генерация исходного кода по всему модулю
    • 2. Включение флага x3-source
    • 3. Пересобрать проект и выполнить компиляцию
  • Основные ошибки
    • 1. Наследование отображений
    • 2. Синтаксис при переопределении
    • 3. Наследование переопределённых выборок
  • Карта модулей
• Подключение сторонних библиотек к локальному globalserver
  • Прямое подключение
• Переход на пакеты сборки
  • Подготовка модуля к переходу на пакеты сборки
    • Настройка пакетов сборки модуля
    • Подготовка классов к генерации контрактов
      • Как определить методы и классы для которых необходимо сгенерировать контракт
      • Подготовка Api для генерации контракта
      • Подготовка Lib для генерации контракта
      • Подготовка Pkg для генерации контракта
    • Генерация контрактов
    • Частые проблемы и их решения
      • Отсутствие case class
      • Метод возвращает провайдер строки от другого класса
      • Ошибка компиляции после переноса case class в пакет сборки core
      • Не получается перенести RegisterBuilder из Api в контракты
      • При генерации отсутствует import или не правильно сгенерировалась структура параметров метода
  • Пакеты сборки
    • Назначение пакетов сборки
    • Базовые пакеты сборки
    • Структура пакетов сборки
    • Настройка пакетов сборки модуля
    • Проектные модули
    • Примечание
  • Контракты
    • Адаптеры
    • Аннотации
    • Генерация контрактов
      • Результат генерации по Api
      • Результат генерации по Lib
      • Результат генерации по Pkg
  • MPI
    • Реализация MPI
    • Использование MPI
    • Ограничения и особенности
    • Частые проблемы и их решения
      • case class недоступен из core
      • Поле объекта-компаньона недоступно из core
• Пример содержимого project.yaml
  • Детальное описание полей конфигурации: