В процессе разработки решений для Revit необходимо публиковать решения на GitHub для обеспечения версионности, организации совместной работы и создания прозрачной истории изменений. ### Зачем это нужно разработчику плагинов?
В одной из статей я уже рассказывал про процесс написания плагина под Revit, советую почитать)
- Безопасность и откат: Если после очередного изменения в C# коде плагин начал «крашить» Revit, вы всегда можете вернуться к стабильной версии за пару кликов.
- Командная работа: Несколько разработчиков могут одновременно работать над разными надстройками или функциями в рамках одного решения, не перезаписывая файлы друг друга. Типо как совместная работа в Revit.
- Портфолио: Для BIM-программиста профиль на GitHub — это живое резюме, которое показывает качество вашего кода и владение Revit API.
Как публиковать свой код в GitHub
Публикацию можно делать как через Visual Studio, так и через терминал ( но это немного сложнее).
Особенности настройки .gitignore для Revit
Это критически важный этап. В репозиторий ( в выгрузку GitHub) не должны попадать временные файлы компиляции и локальные настройки.
Что обязательно нужно добавить в исключения:
- Папки bin/ и obj/ — там хранятся скомпилированные .dll, которые нет смысла версионировать.
- Файлы .user — в них Visual Studio хранит ваши локальные пути (например, путь к Revit.exe для отладки), которые у другого разработчика будут отличаться.
- Файлы манифестов .addin, если они содержат абсолютные пути к вашей локальной папке.
Совет: Используйте стандартный шаблон VisualStudio.gitignore, но добавьте в него специфику для Revit, чтобы случайно не «засорить» ветку.
Работа с внешними зависимостями (RevitAPI.dll)
Одной из главных проблем при публикации на GitHub является ссылка на библиотеки Revit.
- Плохая практика: Загружать RevitAPI.dll и RevitAPIUI.dll прямо в репозиторий. Это раздувает его объем и нарушает лицензионные соглашения.
- Хорошая практика: Использовать NuGet-пакеты (например, официальные от Autodesk или популярные сборки вроде Revit.RevitApi.x64). Это позволит любому, кто скачает ваш проект, собрать его без поиска библиотек на диске C:\.
Оформление README: Лицо вашего плагина
README - файл, где описан принцип работы плагина. Хорошей практикой является добавлять в репозиторий файл README. Хороший README.md должен содержать:
- Скриншот или GIF работы плагина в интерфейсе Revit.
- Поддерживаемые версии: (например, Revit 2021-2024).
- Инструкция по установке: Куда положить .addin файл и .dll, чтобы кнопка появилась на ленте.