diff --git a/.github/RELEASE_POLICY.md b/.github/RELEASE_POLICY.md index 74c2260..80714ea 100644 --- a/.github/RELEASE_POLICY.md +++ b/.github/RELEASE_POLICY.md @@ -1,5 +1,7 @@ # 4FusionLab — automatic runtime release policy +[Русская версия](RELEASE_POLICY.ru.md) + ## Trigger - A direct push to `main` or a PR merge into `main` is the only normal release event. PR checks, manual CI dispatch and version-tag pushes **do not** initiate publication. diff --git a/.github/RELEASE_POLICY.ru.md b/.github/RELEASE_POLICY.ru.md new file mode 100644 index 0000000..bc7d92e --- /dev/null +++ b/.github/RELEASE_POLICY.ru.md @@ -0,0 +1,23 @@ +# 4FusionLab — политика автоматических релизов исполняемых компонентов + +[English](RELEASE_POLICY.md) + +## Запуск + +- Прямой push в `main` или объединение PR в `main` — единственное обычное событие релиза. Проверки PR, ручной запуск CI и отправка тегов версий **не** запускают публикацию. +- Перед публикацией сравнивайте весь диапазон `github.event.before..GITHUB_SHA`, включая переименованные и удалённые исполняемые файлы. Релиз допустим **только**, если отправленные коммиты изменяют поставляемый файл аддона или исполняемой среды, ресурс, нативный компонент либо явно назначенный вход дистрибутива. +- Репозитории с поставляемыми исполняемыми компонентами используют `.github/release-paths.txt` как проверенный перечень, контролируемый `scripts/release_changes.py`. В репозиториях без исполняемых компонентов нет задания релиза. Изменения только README, руководств, проектной документации, скриншотов, тестов, CI, политики репозитория или конфигурации GitVersion не должны публиковать релиз. +- До публикации должны успешно завершиться все обязательные существующие проверки CI. При отказе проверки не создаётся релиз, не изменяется тег и не заменяются артефакты. + +## Версия и распространение + +- GitVersion.Tool **6.8.2** определяет числовую версию `MAJOR.MINOR.PATCH` с помощью `GitVersion.yml` и полной истории Git. ZIP пакета, встроенный манифест Fusion (где применимо), автоматически созданный неизменяемый тег `vMAJOR.MINOR.PATCH` и GitHub Release относятся к одному коммиту и версии. +- Конвейер создаёт тег **автоматически** при публикации GitHub Release. Участники никогда не создают и не отправляют теги релизов вручную. Существующий тег версии, указывающий на другой коммит, считается ошибкой; опубликованный релиз никогда не перезаписывается. +- При наличии используются проверенные заметки конкретной версии; иначе заметки автоматически создаются из истории Git. Подготовка файла заметок вручную только для выпуска изменения кода не требуется. +- Стабильные релизы становятся Latest. Предварительные выпуски никогда не становятся Latest. Продолжают действовать проектные ограничения приёмки CAD, тестирования, подписанных архивов и контрольных сумм, совместимости ОС и публикации. + +## Этот репозиторий + +Этот репозиторий сейчас содержит документацию проекта, но не содержит поставляемого кода аддона. Поэтому автоматического GitHub Release нет; добавление исполняемых исходников и проверенного дистрибутива требует отдельного рассмотренного изменения. + +Если push не меняет подходящие исполняемые файлы, CI может запуститься, но задание GitHub Release пропускается, даже если GitVersion вычисляет другую версию-кандидат. diff --git a/AGENTS.md b/AGENTS.md index 5280c0f..defbf5b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,21 +1,23 @@ -# Разработка Planara +# Planara development -Planara — проектируемый аддон Autodesk Fusion для развёртки выбранных граней Solid Body в плоскую геометрию. +[Русская версия](AGENTS.ru.md) -## Общие правила 4FusionLab +Planara is a planned Autodesk Fusion add-in for flattening selected Solid Body faces into planar geometry. -- Общие стандарты: https://github.com/4FusionLab/.github/blob/main/AGENTS.md; модель общего CI: https://github.com/4FusionLab/.github/blob/main/RELEASE_PLATFORM.md. -- Общайся и составляй планы на русском, код и UI Fusion — на английском. Сохраняй независимые README.md и README.ru.md. -- Перед изменениями изучай текущие файлы и Git-статус. Conventional Commits; предпочтительно PR с успешными проверками, прямой push в main допускается. -- Не меняй UUID Fusion manifest, IDs команд, поддержку ОС и формат пакета без миграционного плана. Не коммить секреты, токены или личные CAD-файлы. -- Где есть runtime, релиз создаёт push или merge в main только для файлов из .github/release-paths.txt после успешного CI. GitVersion.Tool 6.8.2, неизменяемый автоматический тег и GitHub Release; теги вручную не создавай. -- Изменение docs, README, тестов, AGENTS.md или CI само по себе не должно выпускать релиз. Общие Actions подключай только по конкретному commit SHA. -- Unit-тесты и ZIP не заменяют нативную проверку Autodesk Fusion. Сохраняй существующие ограничения и доказательства совместимости. +## Shared 4FusionLab rules -## Текущий статус +- Shared standards: https://github.com/4FusionLab/.github/blob/main/AGENTS.md; shared CI model: https://github.com/4FusionLab/.github/blob/main/RELEASE_PLATFORM.md. +- Communicate and make plans in Russian; use English for code and Fusion UI. Retain separate README.md and README.ru.md. +- Inspect current files and Git status before changes. Use Conventional Commits; a PR with passing checks is preferred, and direct push to main is allowed. +- Do not change Fusion manifest UUIDs, command IDs, OS support or package format without a migration plan. Do not commit secrets, tokens or personal CAD files. +- Where runtime exists, a push or merge to main creates a release only for paths in .github/release-paths.txt after successful CI. Use GitVersion.Tool 6.8.2, an automatically created immutable tag and GitHub Release; do not create tags manually. +- Docs, README, tests, AGENTS.md or CI changes must not independently publish a release. Pin shared Actions only to a specific commit SHA. +- Unit tests and ZIPs do not replace native Autodesk Fusion validation. Preserve existing limitations and compatibility evidence. -- Пока репозиторий содержит только концепцию и документацию: готового распространяемого аддона и релизного pipeline нет. Не утверждай обратное. -- MVP нацелен на результат в виде плоских Surface Bodies; деформацию на неразвёртываемых поверхностях измеряй, а не скрывай. -- Оригинальная геометрия модели должна оставаться неповреждённой. Проверяй реальные ограничения Autodesk Fusion API и разделяй проверенные алгоритмы и гипотезы. -- Перед первым выпуском нужны отдельный уникальный Fusion manifest, runtime-код, воспроизводимые тесты, native CAD acceptance, .github/release-paths.txt, версия, проверенный ZIP и автоматический CI release workflow. -- При появлении пользовательских возможностей обновляй английский и русский README. +## Current status + +- The repository currently contains only the concept and documentation: there is no finished distributable add-in or release pipeline. Do not claim otherwise. +- The MVP targets flat Surface Bodies; measure deformation on non-developable surfaces rather than hiding it. +- Original model geometry must remain intact. Verify actual Autodesk Fusion API limitations and distinguish tested algorithms from hypotheses. +- A first release requires a separate unique Fusion manifest, runtime code, reproducible tests, native CAD acceptance, .github/release-paths.txt, a version, verified ZIP and automatic CI release workflow. +- Update the English and Russian READMEs when user-facing capabilities appear. diff --git a/AGENTS.ru.md b/AGENTS.ru.md new file mode 100644 index 0000000..27c2c3d --- /dev/null +++ b/AGENTS.ru.md @@ -0,0 +1,23 @@ +# Разработка Planara + +[English](AGENTS.md) + +Planara — проектируемый аддон Autodesk Fusion для развёртки выбранных граней Solid Body в плоскую геометрию. + +## Общие правила 4FusionLab + +- Общие стандарты: https://github.com/4FusionLab/.github/blob/main/AGENTS.md; модель общего CI: https://github.com/4FusionLab/.github/blob/main/RELEASE_PLATFORM.md. +- Общайся и составляй планы на русском, код и UI Fusion — на английском. Сохраняй независимые README.md и README.ru.md. +- Перед изменениями изучай текущие файлы и Git-статус. Conventional Commits; предпочтительно PR с успешными проверками, прямой push в main допускается. +- Не меняй UUID Fusion manifest, IDs команд, поддержку ОС и формат пакета без миграционного плана. Не коммить секреты, токены или личные CAD-файлы. +- Где есть runtime, релиз создаёт push или merge в main только для файлов из .github/release-paths.txt после успешного CI. GitVersion.Tool 6.8.2, неизменяемый автоматический тег и GitHub Release; теги вручную не создавай. +- Изменение docs, README, тестов, AGENTS.md или CI само по себе не должно выпускать релиз. Общие Actions подключай только по конкретному commit SHA. +- Unit-тесты и ZIP не заменяют нативную проверку Autodesk Fusion. Сохраняй существующие ограничения и доказательства совместимости. + +## Текущий статус + +- Пока репозиторий содержит только концепцию и документацию: готового распространяемого аддона и релизного pipeline нет. Не утверждай обратное. +- MVP нацелен на результат в виде плоских Surface Bodies; деформацию на неразвёртываемых поверхностях измеряй, а не скрывай. +- Оригинальная геометрия модели должна оставаться неповреждённой. Проверяй реальные ограничения Autodesk Fusion API и разделяй проверенные алгоритмы и гипотезы. +- Перед первым выпуском нужны отдельный уникальный Fusion manifest, runtime-код, воспроизводимые тесты, native CAD acceptance, .github/release-paths.txt, версия, проверенный ZIP и автоматический CI release workflow. +- При появлении пользовательских возможностей обновляй английский и русский README.