Упаковка значений метаданных, влияющих на пользовательский интерфейс коллекции PowerShell

В этой статье объясняется, как метаданные в пакетах используются коллекцией PowerShell. Для модулей метаданные хранятся в манифесте модуля. Для скриптов метаданные хранятся с использованием ключевых слов на основе комментариев. Для создания или обновления этих метаданных используются следующие командлеты:

• New-ModuleManifest
• Update-ModuleManifest
• Новое-ScriptFileInfo
• Обновить-СкриптФайлИнфо

Элементы функций коллекции PowerShell, управляемые манифестом модуля

В следующем списке показаны элементы пользовательского интерфейса страницы пакета коллекции PowerShell, которые управляются манифестом модуля.

• Title — имя пакета, опубликованного в Gallery.

• Версия — отображаемая версия — это строка версии в метаданных и метка предварительной версии, если указана. Указанная строка предварительной версии добавляется в ModuleVersion. Сведения о предварительных версиях строк в модулях см. в разделе Предварительные версии модулей.

• Описание — это описание в манифесте модуля.

• Требовать принятия лицензии - Модуль может потребовать, чтобы пользователь принял лицензию, установив RequireLicenseAcceptance = $true, указав LicenseURI и указав license.txt файл в корне папки модуля. Дополнительные сведения см. в разделе Требование принятия лицензии.

• Примечания к выпуску - Эта информация взята из раздела Примечания к выпуску в разделе PSData\PrivateData.

• Владельцы — это список пользователей в коллекции PowerShell, которые могут обновлять пакет. Список владельцев не включается в манифест пакета. В дополнительной документации описывается, как управлять владельцами элементов.

• Автор — включается в манифест модуля в качестве автора. Поле «Автор» часто используется для указания компании или организации, связанной с пакетом.

• Copyright — это поле Copyright в манифесте модуля.

• FileList — список файлов создается при публикации пакета в коллекции PowerShell. Она не контролируется с помощью информации манифеста. Коллекция PowerShell создает .nuspec файл, который отображается в списке файлов каждого пакета. Этот файл не устанавливается вместе с пакетом в системе. Это манифест пакета NuGet для пакета, который можно игнорировать.

• Теги - Теги включены в PrivateData\PSData манифест модуля. Теги имеют определенные требования и значения, которые описаны в разделе Сведения о тегах .

• Cmdlets — это предоставляется в манифесте модуля с помощью CmdletsToExport. Рекомендуется явно перечислять имена командлетов, а не использовать подстановочный знак *. Наличие списка улучшает производительность модуля загрузки.

• Функции — это предоставляется в манифесте модуля с помощью FunctionsToExport. Рекомендуется явно перечислять имена командлетов, а не использовать подстановочный знак *. Наличие списка улучшает производительность модуля загрузки.

• Ресурсы DSC — это предоставляется в манифесте с помощью DscResourcesToExport. Это значение поддерживается только для модулей в PowerShell 5.0 и более поздних версиях.

• Возможности ролей — роли перечисляются, если модуль имеет один или несколько файлов возможностей ролей (.psrc). Эти файлы используются JEA. Дополнительные сведения см. в разделе Возможности ролей.

• PowerShell Editions — для модулей , разработанных для PowerShell 5.0 и более ранних версий, это контролируется с помощью тегов. Для Desktop используйте тег PSEdition_Desktop, а для core — тег PSEdition_Core. Для модулей, разработанных для PowerShell 5.1 и более поздних версий, в манифесте есть ключ CompatiblePSEditions . Дополнительные сведения см. в разделе Поддержка модулей PSEdition.

• Зависимости — это предоставляется в манифесте с помощью RequiredModules.

• Минимальная версия PowerShell — указывается в манифесте с помощью PowerShellVersion.

• Журнал версий — показывает список версий модуля, которые были опубликованы в галерее. Пакеты, скрытые с помощью функции «Удалить », не отображаются в журнале версий, если вы не являетесь владельцем пакета.

• Сайт проекта — сайт проекта предоставляется для модулей в PrivateData\PSData разделе манифеста модуля путем указания ProjectURI.

• Лицензия - Ссылка на лицензию предоставляется для модулей в PrivateData\PSData разделе манифеста модуля путем указания LicenseURI.

  Это важно

  Если лицензия не предоставляется через LicenseURI или в пакете, то к пакету применяются Условия использования коллекции PowerShell. Для получения дополнительной информации см. Условия использования.

• Icon — ссылка на модули предоставляется в PrivateData\PSData разделе манифеста модуля путем указания IconURI. URI должен указывать на изображение размером 85x85 с прозрачным фоном. URI должен быть прямой ссылкой на файл изображения и не должен вести на веб-страницу или в файл в пакете коллекции PowerShell.

Элементы функций коллекции PowerShell, управляемые метаданными скрипта

В следующем списке показаны элементы пользовательского интерфейса страницы пакета коллекции PowerShell, которые управляются метаданными на основе комментариев в файле скрипта.

• Title — это имя пакета, который публикуется в галерее

• Версия — отображаемая версия — это строка версии в метаданных и метка предварительной версии, если указана. Значение берется из .VERSION ключевого слова в блоке комментариев к метаданным. При публикации сценария предварительной версии добавьте строку предварительной версии к версии. Сведения об указании строк предварительной версии в модулях см. в разделе Предварительные версии скриптов.

• Описание — эта информация берется из ключевого .DESCRIPTION слова в справке на основе комментариев файла скрипта.

• Требовать принятия лицензии — принятие лицензии не поддерживается для скриптов. Однако поддерживается сценарий, в котором сценарий зависит от модуля, требующего принятия лицензии. Дополнительные сведения см. в разделе Требование принятия лицензии для скриптов.

• Примечания к выпуску — эта информация поступает из ключевого .RELEASENOTES слова в метаданных файла скрипта на основе комментариев.

• Владельцы — это список пользователей в коллекции PowerShell, которые могут обновлять пакет. Список владельцев не включается в манифест пакета. Дополнительные сведения см. в разделе Управление владельцами элементов.

• Автор — эта информация поступает из ключевого .AUTHOR слова в метаданных файла скрипта на основе комментариев. Поле «Автор» часто используется для указания компании или организации, связанной с пакетом.

• Авторское право — эта информация поступает из ключевого .COPYRIGHT слова в метаданных на основе комментариев файла скрипта.

• FileList — список файлов создается при публикации пакета в коллекции PowerShell. Она не контролируется с помощью информации манифеста. Коллекция PowerShell создает .nuspec файл, который отображается в списке файлов каждого пакета. Этот файл не устанавливается вместе с пакетом в системе. Это манифест пакета NuGet для пакета, который можно игнорировать.

• Теги - *Эта информация поступает из ключевого .TAGS слова в метаданных на основе комментариев файла скрипта. Теги имеют определенные требования и значения, которые описаны в разделе Сведения о тегах .

• PowerShell Editions — для модулей , разработанных для PowerShell 5.0 и более ранних версий, это контролируется с помощью тегов. Для Desktop используйте тег PSEdition_Desktop, а для core — тег PSEdition_Core. Для модулей, разработанных для PowerShell 5.1 и более поздних версий, в манифесте есть ключ CompatiblePSEditions . Дополнительные сведения см. в разделе Поддержка модулей PSEdition.

• Журнал версий — показывает список версий модуля, которые были опубликованы в галерее. Пакеты, скрытые с помощью функции «Удалить », не отображаются в журнале версий, если вы не являетесь владельцем пакета.

• Сайт проекта — эта информация поступает из .PROJECTURI ключевого слова в метаданных файла скрипта на основе комментариев.

• Лицензия — эта информация поступает из .LICENSEURI ключевого слова в метаданных файла скрипта на основе комментариев.

  Это важно

  Если лицензия не предоставляется через .LICENSEURI пакет или внутри него, то к пакету применяются Условия использования коллекции PowerShell. Для получения дополнительной информации см. Условия использования.

• Значок — эта информация поступает из ключевого .ICONURI слова в метаданных файла скрипта на основе комментариев. URI должен указывать на изображение размером 85x85 с прозрачным фоном. URI должен быть прямой ссылкой на файл изображения и не должен вести на веб-страницу или в файл в пакете коллекции PowerShell.

Редактирование сведений о пакете

Страница редактирования пакета коллекции PowerShell позволяет издателям изменять несколько полей, отображаемых для пакета, а именно:

• Название
• Description
• Сводка
• URL-адрес значка;
• URL главной страницы проекта
• авторов
• Авторские права
• Метки
• Примечания к релизу
• Требуется лицензия

Эту информацию следует редактировать только в Галерее, чтобы исправить то, что отображается в более ранней версии модуля. Пользователи, скачавшие пакет, увидят, что метаданные не соответствуют коллекции PowerShell. Каждый раз, когда вы изменяете информацию в Галерее, вы должны опубликовать новую версию пакета с теми же изменениями.

Сведения о теге

Теги — это простые строки, которые потребители используют для поиска посылок. Теги наиболее ценны, когда они используются последовательно во всех связанных пакетах. Использование вариаций одного и того же слова, например, база данных и базы данных или тест и тестирование, дает мало пользы. Теги — это строки, состоящие из одного слова и не зависящие от регистра, и не могут содержать пробелы. Если есть фраза, которую, по вашему мнению, пользователи будут искать, добавьте ее в описание пакета, чтобы ее можно было найти в результатах поиска. Используйте регистр Паскаля, дефисы, символы подчеркивания или точки для улучшения читаемости. Будьте осторожны при создании длинных, сложных и необычных тегов, в которых легко сделать ошибку.

В коллекции PowerShell и командлетах PowerShellGet есть специальные значения для тегов PSEdition_Desktop and PSEdition_Core . Ознакомьтесь с предыдущим описанием выпусков PowerShell.

Как отмечалось ранее, теги обеспечивают наибольшую ценность, когда они специфичны и используются последовательно во многих пакетах. Если издатель пытается найти наиболее подходящие теги для использования, самый простой подход — выполнить поиск в коллекции PowerShell по тегам, которые вы рассматриваете. В идеале возвращаемые пакеты должны соответствовать используемому вами ключевому слову.

В следующей таблице приведены некоторые из наиболее часто используемых тегов. Предпочитаемый тег должен возвращать лучшие результаты поиска.