docs(workflow): align branch and release instructions - #10
Merged
Merged
Conversation
…нструкции веток и релизов
…огласования инструкций
prikotov
marked this pull request as ready for review
September 11, 2026 04:03
…равило отчётности
…за и срочного исправления
…та срочного исправления
…го исправления до выпуска
…ного исправления по запросу
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Задача
Согласовать исходные Git-инструкции и убрать избыточные пояснения.
TASK-docs-align-workflow-instructions—done, готово к приёмке.Связанные PR: TasK #2899, todo-md #31.
Изменения
deploy.mdудалена дублирующая строка «Выкладка из вершины ветки запрещена»; требование выкладки по конкретному тегу релиза сохранено. В рекомендуемом потоке выделено выполнение подготовительных и завершающих действий изdocs/releases/vX.Y.Z/на указанных там этапах; инструкции дополняются при выполнении задач. Проверены точечность дополнения, сохранение порядка шагов и требований к разрешениям.branches.mdиrelease.mdдобавлены короткие комментарии кgit remote set-head origin --auto, чтению имени основной ветки черезgit symbolic-refи удалению префиксаorigin/при переключении. Уточнено, что обновляется локальный указатель; универсальность и команды сохранены.branches.md: типы веток собраны в разделе «Работа с ветками». Каждая секция Task/Release/Hotfix содержит назначение, именование с примером, создание, синхронизацию и завершение; для hotfix также описан возврат в основную ветку. Общие разделы именования, синхронизации и завершения удалены; требование повторного одобрения перенесено в общие правила. Для синхронизации закреплён толькоmerge, без переписывания существующих коммитов; три вариантаrebaseудалены. Команды создания веток сохранены; hotfix синхронизируется только с целевойorigin/release/x.y.z. Способы интеграции PR на GitHub не менялись.branches.mdсценарии разделены:Release branchописывает только обычный релиз от основной ветки; весь срочный сценарий находится вHotfix branch, включая создание целевойrelease/x.y.zот рабочего тега и возврат после публикации GitHub Release. Примеры создания обеих релизных веток сохранены и совпадают сrelease.md; перед ними указана проверка свободных имён.hotfixиpatch release, подсказки профилей ролей и проверку безопасного порядка обновления. Удалены дублирующие поля «Вне состава релиза» и «Риск окна несовместимости»; слияние подготовки явно требуется до создания тега.release/x.y.zв основную ветку.docs/git-workflow/glossary.md: 26 коротких определений в формате «русский термин (English) — пояснение», с отдельным стабильным якорем каждого термина. Ссылки добавлены в оглавление, README и регламент выпуска; вdeploy.mdопределение выкладки приведено без ссылки на словарь. Публикация версии отделена от установки в рабочую среду.release/x.y.z, включая каждый патч. Все релизные ветки и теги сохраняются. Общиеrelease/x.yбольше не используются; ветки других выпусков не переиспользуются и не перезаписываются.release/x.y.z→ PR в основную → проверенный результат слияния → тег. Основная ветка определяется через актуальныйorigin/HEAD, без ручной заменыmaster/main.v1.2.0: новыеrelease/1.2.1иhotfix/1.2.1-…от рабочего тега → одобренный PR исправления вrelease/1.2.1→ слияние → тегv1.2.1на проверенном результате → выпуск → PR изrelease/1.2.1в основную. Стараяrelease/1.2.0не меняется.task/*иhotfix/*, но неrelease/*.git fetchсозданиеhotfix/*теперь останавливается.Проверки
Проверено отсутствие
make-команд в распространяемой документации, сохранение условий сквозных тестов для обоих сценариев и проектных исключений. Примеры Git-команд, ветки и инструкция выкладки не изменились. Повторены 774 проверки Git-модели и проверка установки всех 13 документов.Личная вычитка без делегирования; проверялась согласованная модель отдельных выпусков, не прежняя общая линия.
composer validate --strict— успешно; приватных зависимостей нет.Валидация задачи,
git diff --check, локальные ссылки и якоря — успешно. Удаление ссылки вdeploy.mdпроверено отдельно: определение и правила сохранены. При пояснении команд проверено добавление только 13 комментариев без изменения команд и другого текста; синтаксис всех затронутых Bash-примеров проверен черезbash -n.Повторены 774 проверки Git-модели на восстановленных примерах из
branches.md, проверено точное совпадение команд сrelease.md: два последовательных патча и следующий обычный релиз;master,main,team/main; merge/squash/rebase первой интеграции; прямой возврат с конфликтами; сохранность всех выпусков; отказы до слияния, при неверном составе, занятом имени, отсутствующем теге и недоступном репозитории. Это изолированные локальные репозитории, не настоящие PR или тесты приложения.Проверены точечность перехода на синхронизацию только через
merge, структура документа и сохранение команд создания веток. Три сценария синхронизации hotfix: успешное слияние целевой ветки, недоступный origin и отсутствующая целевая ветка. Существующие коммиты сохраняются, невыпущенные изменения основной ветки не попадают в hotfix; теги и удалённые ветки не изменяются. Отдельно выполнен пример возврата после моделируемой публикации: адаптируется только релизная ветка, hotfix и опубликованные теги сохраняются. Проверено отсутствие срочного сценария в секцииRelease branch. После переноса именования и завершения проверены порядок подразделов, сохранение примеров имён, правил удаления и хранения веток и тегов; все команды и их порядок остались прежними.Повторены 30 проверок команд
origin/HEAD: разные имена и состояния ссылки, создание задачи, синхронизация task/release черезmergeс сохранением существующих коммитов и остановка при ошибках подготовки.Проверены подсказки шаблонов, точный состав изменений и неизменность условий E2E. Обычный шаблон согласован со срочным по общим разделам; отдельно проверены сохранение выбора версии, плановой даты, описания несовместимых изменений и обязательных E2E. Последняя правка не меняет срочный шаблон. Словарь проверен на формат всех 26 определений, уникальность якорей и отображение Markdown. Установка и повторная установка 13 документов в стандартный и нестандартный каталоги совпадают с исходниками; без
--forceпользовательские файлы сохранены, с--forceобновлены конвенции без изменения заполненного плана.Отдельных статического и архитектурного анализаторов в CI пакета нет. Изменена только документация; тесты приложения не запускались.
Ограничения
CI пакета пока запускается только для PR в
master/main. Перед реальным срочным выпуском отдельно согласовать включениеrelease/*в CI. Настройки сейчас не менялись; автоматическое удаление исходных веток после слияния вgit-workflowи TasK отключено.Код, конфигурации, зависимости и установленные копии TasK не изменены. Слияние этих PR, выпуски и теги в реальных репозиториях не выполнялись.