История проекта
Краткий обзор
- Узнайте, где найти представление «История» и как события проекта располагаются на временной шкале.
- Ознакомьтесь с требованиями к системе управления версиями для просмотра истории коммитов.
- Узнайте, как просматривать изменения в коммитах, открывать снимки предыдущих состояний проекта и добавлять теги к коммитам.
Отсутствие удобного доступа к истории разработки проекта нередко раздражает разработчиков и менеджеров по продукту. Слишком часто разработчику приходится осваивать внешние инструменты управления системами контроля версий (VCS), для работы с которыми может потребоваться немалый опыт. Это отнимает много времени, особенно когда нужно выполнить базовые задачи управления проектом. Даже если вы уверенно пользуетесь внешними инструментами VCS, они охватывают лишь отдельные аспекты проекта — связанные с контролем версий действия, такие как открытие, клонирование и откат. А как же более широкий круг задач управления проектом, включая выпуски и обмен данными с MCAD? Кроме того, не стоит забывать, что для большинства этих действий обычно приходится работать за настольным компьютером.
Предлагая удобное решение для просмотра такой информации и работы с ней в одном месте, рабочее пространство Altium 365 Workspace поддерживает концепцию Project History. Специальное представление History , доступное через браузерный интерфейс рабочего пространства (составную часть основного интерфейса платформы Altium 365) или из Altium Designer, отображает хронологию основных событий проекта: его создания, фиксаций изменений, выпусков, клонирования и обмена данными с MCAD. Для соответствующих событий доступны различные действия, например просмотр снимка исходных данных проекта.
Доступ к истории проекта
Доступ к представлению History проекта осуществляется со страницы подробного управления этим проектом. Нажмите пункт History на левой панели.
Откройте историю проекта со страницы подробного управления этим проектом.
Временная шкала истории — обзор
В представлении History отображается временная шкала основных событий, произошедших в ходе развития проекта. Ее можно условно разделить на три ключевые составляющие, показанные на следующем изображении и подробно описанные далее.
Три ключевые составляющие представления History .
- Main trunk of the timeline. События располагаются в хронологическом порядке снизу вверх. Первое событие — создание проекта — отображается в нижней части временной шкалы. Последующие события располагаются выше, а последнее (самое новое) — в самом верху.
- Events. Каждый раз, когда с проектом происходит поддерживаемое событие (см. ниже), оно добавляется на временную шкалу в виде отдельной карточки. Для каждого типа событий используется свой цвет карточки; карточка либо непосредственно связана с основной линией временной шкалы, либо рядом с ней отображается дополнительный значок (как в случае событий обмена данными с MCAD).
-
Search. Нажмите элемент управления
в правом верхнем углу представления, чтобы открыть поле для простого поиска по истории проекта. По мере ввода поисковой строки временная шкала фильтруется, и на ней остаются только события, соответствующие запросу. Дополнительные сведения см. в разделе Поиск с фильтрацией.
Поддерживаемые события
Временная шкала показывает последовательность событий, происходящих на протяжении жизненного цикла проекта. Каждое из этих событий отображается на временной шкале в виде отдельной «карточки события». В следующих разделах рассматриваются типы событий, которые в настоящее время поддерживаются и могут отображаться в истории проекта.
Создание проекта
Related pages: Создание нового управляемого проекта (браузерный интерфейс / Altium Designer), предоставление онлайн-доступа к существующему проекту, клонирование проекта (браузерный интерфейс / Altium Designer)
При создании проекта на временную шкалу добавляется карточка события Project Created. Это событие отмечает начало истории проекта. Поэтому оно всегда находится в самом низу временной шкалы. Карточка этого события может отображаться в двух вариантах:
- Когда в рабочем пространстве создается новый проект. На карточке отображаются имя (и фотография) создателя проекта, а также дата и время создания проекта. В карточке также отображается описание проекта, если оно было введено при создании.
- Если проект является клоном существующего проекта. Отображаются имя и фотография пользователя, создавшего клонированный проект, а также дата и время создания проекта. Если при клонировании было введено описание проекта, оно также отображается на карточке. Предусмотрена ссылка на исходный проект: при нажатии на нее в отдельной вкладке браузера открывается страница подробного управления этим проектом.
Фиксация проекта
Каждый раз, когда вы выполняете Commit & Push проекта в рабочее пространство (где проект находится под управлением внутреннего Git-репозитория Versioned Storage рабочего пространства), на временную шкалу добавляется карточка события Project Committed. На ней отображаются имя и фотография пользователя, выполнившего фиксацию и отправку, а также дата и время. Если при фиксации и отправке в диалоговом окне Commit to Version Control был добавлен комментарий, он также отображается на карточке.
Пример карточки первоначального события Project Committed.
На карточке также отображаются сведения о различиях в проекте, позволяющие подробнее узнать, что изменилось между текущей и предыдущей фиксациями. Поддерживаются следующие типы элементов: файлы, компоненты, цепи, варианты и структура печатной платы. В разделе различий на карточке приводится сводка по элементам, затронутым фиксацией, сгруппированным по следующим состояниям:
— элемент добавлен.
— элемент удален.
— элемент изменен.
Нажмите элемент управления
на карточке, чтобы развернуть раздел различий и отобразить имена затронутых элементов.
Нажмите элемент управления
в правом верхнем углу карточки, чтобы открыть меню со следующими командами:
- View — открывает исходные данные проекта для выбранной фиксации в Web Viewer в виде снимка проекта на соответствующий момент времени.
- Create Tag — добавляет имя тега VCS к выбранной фиксации. Теги, присвоенные фиксации, отображаются на ее карточке в представлении History, в заголовке представления ее снимка в Web Viewer, а также в комментариях к этому снимку. После добавления тега к фиксации команда меню карточки меняется на Tag и содержит подкоманды для изменения (Edit) или удаления (Remove) тега фиксации.
Выберите пункт меню Create Tag, чтобы добавить имя тега к событию фиксации в истории.
В представлении снимка события фиксации с тегом отображается имя этого тега.
При просмотре комментариев в текущей рабочей версии проекта (WIP) комментарии, созданные в снимке проекта для фиксации с тегом, будут содержать имя соответствующего тега. Нажмите ссылку с именем тега, чтобы открыть снимок соответствующей фиксации. Дополнительные сведения о работе с комментариями см. в разделе Комментарии в Web Viewer.
Комментарии, добавленные к снимку события фиксации с тегом, будут содержать имя соответствующего тега.
Событию фиксации, связанному с выпуском проекта, созданным с помощью Project Releaser в Altium Designer, автоматически присваивается тег идентификатора ревизии выпуска. При необходимости этот тег фиксации ревизии впоследствии можно изменить или удалить. Дополнительные сведения см. в разделе Выпуск в рабочее пространство.
Altium Designer автоматически присваивает фиксации, связанной с выпуском, тег с идентификатором выпуска.
- Schematic to — позволяет сравнить данные электрической схемы в этой фиксации с данными другой фиксации или события выпуска. Используйте подменю для сравнения с исходными данными предыдущей фиксации либо выберите нужную фиксацию или выпуск из всех доступных. После выбора выпуска или фиксации для сравнения результаты отображаются в представлении Compare, которое открывается в новой вкладке браузера по умолчанию. Дополнительные сведения см. в разделе Сравнение электрических схем.
- PCB to — позволяет сравнить данные печатной платы в этой фиксации с данными другой фиксации или события выпуска. Используйте подменю для сравнения с исходными данными предыдущей фиксации либо выберите нужную фиксацию или выпуск из всех доступных. После выбора выпуска или фиксации для сравнения результаты отображаются в представлении Compare, которое открывается в новой вкладке браузера по умолчанию. Дополнительные сведения см. в разделе Сравнение печатных плат.
- BOM to – позволяет сравнить данные спецификации (BOM) в этом коммите с данными другого коммита или выпуска. Используйте соответствующее подменю, чтобы сравнить их с данными спецификации предыдущего коммита или выбрать любой из коммитов или выпусков проекта. После выбора объекта для сравнения результаты отображаются в виде списка позиций спецификации с цветовым выделением, обозначающим изменения между указанными коммитами или выпусками. Сводка изменений формируется в стандартном формате CSV и доступна для скачивания в ZIP-архиве. Подробнее см. Сравнение спецификаций.
-
Clone – используйте эту команду, чтобы создать клон указанной ревизии проекта. Откроется окно Clone Project, в котором можно задать Name, Description и Parent Folder проекта (в рабочем пространстве). Обратите внимание: текст в верхней части окна указывает, на основе какой ревизии проекта создается клон. Указав необходимые сведения, нажмите кнопку
. Будет создан проект, а на временную шкалу добавится карточка события Project Cloned.
Вы можете создать клон любой ревизии активного проекта непосредственно из соответствующей карточки события Project Committed для этой ревизии.
- Download Sources – используйте эту команду, чтобы скачать исходные файлы указанной ревизии проекта в ZIP-архиве. Имена ZIP-архива и файла проекта печатной платы будут содержать дату и время (UTC), когда эта ревизия проекта была зафиксирована коммитом и отправлена в рабочее пространство.
Выпуск проекта
Related page: Выпуск проекта
При каждом выпуске проекта с помощью Project Releaser в Altium Designer на временную шкалу добавляется карточка события Project Released. На ней отображаются имя и фотография пользователя, выполнившего выпуск, а также дата и время. Если при публикации сформированных данных в рабочем пространстве через диалоговое окно Confirm Release было добавлено примечание к выпуску, оно также отображается на карточке. Кроме того, на ней перечислены все наборы данных, включенные в выпуск, с указанием их состояний жизненного цикла.
Пример карточки события Project Released.
Нажмите элемент управления
в правом верхнем углу карточки, чтобы открыть меню со следующими командами:
- View – открывает специализированный производственный портал (на отдельной вкладке браузера) для подробного изучения выпущенных данных. На этом портале можно просматривать выпущенные файлы и перемещаться по ним, изучать спецификацию, а также просматривать и комментировать снимок самого проекта, на основе которого были сформированы данные выпуска. Также доступны средства скачивания производственных данных с разной степенью детализации: от полных наборов данных до отдельных сформированных выходных файлов. Выбранный выпуск можно также отправить непосредственно производителю в виде Manufacturing Package. Подробнее см. Просмотр пакета выпуска на производственном портале.
Открытие специальной вкладки Manufacturing Portal для подробного изучения выпуска проекта.
- Schematic to – позволяет сравнить данные схемы в этом выпуске с данными другого выпуска или коммита. Используйте подменю, чтобы сравнить их с исходными данными предыдущего выпуска или выбрать любой из доступных выпусков и коммитов. После выбора выпуска или коммита для сравнения результаты отображаются в представлении Compare, которое открывается на новой вкладке браузера по умолчанию. Подробнее см. Сравнение схем.
Сравнение данных схемы между двумя выпусками проекта.
- PCB to – позволяет сравнить данные печатной платы в этом выпуске с данными другого выпуска или коммита. Используйте подменю, чтобы сравнить их с исходными данными предыдущего выпуска или выбрать любой из доступных выпусков и коммитов. После выбора выпуска или коммита для сравнения результаты отображаются в представлении Compare, которое открывается на новой вкладке браузера по умолчанию. Подробнее см. Сравнение печатных плат.
Сравнение данных печатной платы между двумя выпусками проекта.
- Gerber to – позволяет сравнить данные Gerber, сформированные для этого выпуска, с другим набором данных Gerber. Используйте соответствующее подменю, чтобы сравнить их с производственными данными предыдущего выпуска, выбрать любой из выпусков проекта (на временной шкале будут отображаться только карточки событий Project Released) или выполнить сравнение с выбранным набором файлов, сформированным локально и загруженным в систему. После выбора объекта для сравнения результаты отображаются в представлении Gerber Compare , которое открывается на отдельной вкладке браузера. Подробнее см. Сравнение данных Gerber.
Сравнение сформированных данных Gerber между двумя выпусками проекта.
- BOM to – позволяет сравнить данные спецификации в этом выпуске с данными другого коммита или выпуска. Используйте соответствующее подменю, чтобы сравнить их с данными спецификации предыдущего коммита или выбрать любой из коммитов или выпусков проекта. После выбора объекта для сравнения результаты отображаются в виде списка позиций спецификации с цветовым выделением, обозначающим изменения между указанными коммитами или выпусками. Сводка изменений формируется в стандартном формате CSV и доступна для скачивания в ZIP-архиве. Подробнее см. Сравнение спецификаций.
Скачивание результатов сравнения сформированных данных спецификации между двумя событиями проекта.
-
Download Outputs – позволяет в открывшемся окне выбрать выходные наборы данных из пакета выпуска для скачивания. Сделав выбор, нажмите кнопку
. Будет скачан один ZIP-архив с папками для каждого из выбранных наборов данных.
- Download Sources – позволяет скачать в ZIP-архиве исходные данные той версии проекта, которая использовалась для создания этого пакета выпуска.
Клонирование проекта
Related page: Клонирование проекта (интерфейс браузера / Altium Designer)
При каждом клонировании проекта — через браузерный интерфейс рабочего пространства или из Altium Designer — на временную шкалу добавляется карточка события Project Cloned. В ней отображаются имя и фотография пользователя, выполнившего клонирование, а также дата и время. Если при клонировании было добавлено описание — в окне Clone Project (в браузере) или в диалоговом окне Clone Project (в Altium Designer), — оно также отображается в карточке. Карточка содержит ссылку на клонированный проект: при нажатии на нее в отдельной вкладке браузера открывается страница подробного управления этим проектом.
Пример карточки события Project Cloned.
Обмен данными с MCAD
Related page: Подробнее о совместном проектировании ECAD-MCAD
При совместной работе над электронной и механической частями изделия рабочее пространство служит связующим звеном между двумя средами, обеспечивая прямое совместное проектирование ECAD-MCAD. Каждый раз, когда изменения, внесенные в проект печатной платы, отправляются в рабочее пространство через соответствующую панель CoDesigner, на временную шкалу добавляется карточка события MCAD Changes Suggested. В ней отображаются имя и фотография пользователя, отправившего изменения, а также дата и время. Если при отправке было добавлено сообщение — через панель MCAD CoDesigner (в Altium Designer) или панель Altium CoDesigner (в поддерживаемой MCAD-системе), — оно также отображается в карточке.
Пример карточки события MCAD Changes Suggested.
Когда инженер-механик вносит изменения в печатную плату в поддерживаемой MCAD-системе и отправляет их в рабочее пространство, соответствующее событие отправки автоматически отображается на временной шкале истории проекта. Обратите внимание: для отображения последнего изменения может потребоваться обновить страницу истории.
Пример двух событий, связанных с MCAD. Слева от основной линии временной шкалы показано событие отправки из ECAD, а справа — событие отправки из MCAD.
Поиск с фильтрацией
Нажмите элемент управления
в правом верхнем углу представления, чтобы открыть поле поиска и быстро найти нужные события на временной шкале. Функция поиска поддерживает простой поиск по истории проекта с динамической фильтрацией по мере ввода поисковой строки: на странице остаются только события, соответствующие запросу. Совпадающий текст в карточках событий выделяется.
Пример поиска по истории проекта. Временная шкала динамически фильтруется по мере ввода поискового запроса без учета регистра, а совпадения выделяются в каждой соответствующей карточке события.
Поиск выполняется по следующим данным:
- Заголовок карточки события.
- Имя пользователя, выполнившего действие.
- Текст описания (текст комментария, примечания или описания, добавленный при соответствующем событии).
- Текст данных сравнения — в карточке события Project Committed.
- Имя набора данных — в карточке события Project Released.
- Имя проекта — в карточке события Project Cloned и карточке события Project Created (при создании путем клонирования).
Добавление новых событий
Каждое поддерживаемое событие, связанное с проектом, автоматически обнаруживается и становится доступным в представлении History . Вскоре после события в нижней части представления появляется уведомление. Нажмите элемент управления
, чтобы добавить новое событие на временную шкалу.