Hodnoty metadat balíčků, které mají vliv na uživatelské rozhraní Galerie prostředí PowerShell

  • Článek

Tento článek vysvětluje, jak Galerie prostředí PowerShell používají metadata v balíčcích. U modulů se metadata ukládají v manifestu modulu. U skriptů se metadata ukládají pomocí klíčových slov založených na komentářích. K vytvoření nebo aktualizaci těchto metadat se používají následující rutiny:

Následující seznam ukazuje prvky uživatelského rozhraní stránky Galerie prostředí PowerShell balíčku, které jsou řízeny manifestem modulu.

  • Název – název balíčku publikovaného v galerii.

  • Verze – zobrazená verze je řetězec verze v metadatech a popisek předběžné verze, pokud je zadaný. Zadaný řetězec předběžné verze je připojen k ModuleVersion. Informace o předběžných verzích řetězců v modulech najdete v tématu Předběžné verze modulů.

  • Popis – Toto je popis v manifestu modulu.

  • Vyžadovat přijetí licence – Modul může vyžadovat, aby uživatel přijal licenci nastavením RequireLicenseAcceptance = $true, zadáním identifikátoru LicenseURI a poskytnutím license.txt souboru v kořenovém adresáři složky modulu. Další informace najdete v tématu Vyžadování přijetí licence.

  • Poznámky k verzi – Tyto informace pocházejí z části ReleaseNotes v části PSData\PrivateData.

  • Vlastníci – Vlastníci jsou seznam uživatelů v Galerie prostředí PowerShell, kteří můžou balíček aktualizovat. Seznam vlastníků není součástí manifestu balíčku. Další dokumentace popisuje, jak spravovat vlastníky položek.

  • Autor – toto je součástí manifestu modulu jako Autor. Pole Autor se často používá k určení společnosti nebo organizace přidružené k balíčku.

  • Copyright –toto je pole Copyright (Autorská práva ) v manifestu modulu.

  • FileList – seznam souborů se vytvoří při publikování balíčku do Galerie prostředí PowerShell. Informace o manifestu ji neovládnou. Galerie prostředí PowerShell vytvoří .nuspec soubor, který se zobrazí v seznamu souborů každého balíčku. Tento soubor není nainstalován spolu s balíčkem v systému. Toto je manifest balíčku NuGet a můžete ho ignorovat.

  • Tagy - Značky jsou součástí PrivateData\PSData manifestu modulu. Značky mají specifické požadavky a významy, které jsou popsány v části Podrobnosti o značkách .

  • Rutiny – to je k dispozici v manifestu modulu pomocí rutinyToExport. Osvědčeným postupem je explicitně vypsat názvy rutin místo použití zástupných znaků *. Seznam zlepšuje výkon modulu načítání.

  • Functions – to je k dispozici v manifestu modulu pomocí FunctionsToExport. Osvědčeným postupem je explicitně vypsat názvy rutin místo použití zástupných znaků *. Seznam zlepšuje výkon modulu načítání.

  • Prostředky DSC – to je k dispozici v manifestu pomocí DscResourcesToExport. Tato hodnota se podporuje jenom pro moduly v PowerShellu 5.0 a novějším.

  • Možnosti rolí – Role jsou uvedené, pokud má modul jeden nebo více souborů funkcí role (.psrc). Tyto soubory používá jea. Další informace najdete v tématu Možnosti rolí.

  • Edice PowerShellu – u modulů určených pro PowerShell 5.0 a nižší je to řízeno pomocí značek. Pro Desktop použijte PSEdition_Desktop značky a jako jádro použijte značku PSEdition_Core. Pro moduly navržené pro PowerShell 5.1 a vyšší je v manifestu klíč CompatiblePSEditions . Další informace najdete v tématu Podpora PSEdition pro moduly.

  • Závislosti – to je k dispozici v manifestu pomocí RequiredModules.

  • Minimální verze PowerShellu – Tato hodnota je k dispozici v manifestu pomocí verze PowerShellu.

  • Historie verzí – zobrazuje seznam verzí modulu, které byly publikovány v galerii. Balíčky skryté pomocí funkce Odstranit se v historii verzí nezobrazí, pokud nejste vlastníkem balíčku.

  • Web projektu – Web projektu se pro moduly poskytuje v PrivateData\PSData části manifestu modulu zadáním identifikátoru ProjectURI.

  • Licence – Pro moduly v PrivateData\PSData části manifestu modulu je k dispozici odkaz na licenci zadáním identifikátoru LicenseURI.

    Důležité

    Pokud licence není poskytnuta prostřednictvím LicenseURI nebo v rámci balíčku, pak se na balíček vztahují Podmínky použití pro Galerie prostředí PowerShell. Další informace najdete v podmínkách použití.

  • Ikona – odkaz na moduly je k dispozici v PrivateData\PSData části manifestu modulu zadáním IconURI. Identifikátor URI by měl odkazovat na obrázek 85 × 85 s průhledností pozadí. Identifikátor URI musí být přímým odkazem na soubor obrázku a nesmí přejít na webovou stránku nebo soubor v Galerie prostředí PowerShell balíčku.

Následující seznam ukazuje prvky uživatelského rozhraní stránky Galerie prostředí PowerShell balíčku, které jsou řízeny metadaty založenými na komentářích v souboru skriptu.

  • Název – toto je název balíčku, který je publikovaný v galerii.

  • Verze – zobrazená verze je řetězec verze v metadatech a popisek předběžné verze, pokud je zadaný. Hodnota pochází z klíčového .VERSION slova v bloku komentáře metadat. Při publikování skriptu předběžné verze připojte k verzi řetězec předběžné verze. Informace o zadávání řetězců předběžné verze v modulech najdete v tématu Předběžné verze skriptů.

  • Popis – Tyto informace pocházejí z klíčového .DESCRIPTION slova v nápovědě k souboru skriptu založeném na komentářích.

  • Vyžadovat přijetí licence – Skripty nepodporují přijetí licence. Podporuje se ale scénář, kdy skript závisí na modulu, který vyžaduje přijetí licence. Další informace najdete v tématu Vyžadování přijetí licence pro skripty.

  • Poznámky k verzi – Tyto informace pocházejí z klíčového .RELEASENOTES slova v metadatech založených na komentářích souboru skriptu.

  • Vlastníci – Vlastníci jsou seznam uživatelů v Galerie prostředí PowerShell, kteří můžou balíček aktualizovat. Seznam vlastníků není součástí manifestu balíčku. Další informace najdete v tématu Správa vlastníků položek.

  • Autor – tyto informace pocházejí z klíčového .AUTHOR slova v metadatech skriptu založených na komentářích. Pole Autor se často používá k určení společnosti nebo organizace přidružené k balíčku.

  • Autorská práva – Tyto informace pocházejí z klíčového .COPYRIGHT slova v metadatech souboru skriptu založených na komentářích.

  • FileList – seznam souborů se vytvoří při publikování balíčku do Galerie prostředí PowerShell. Informace o manifestu ji neovládnou. Galerie prostředí PowerShell vytvoří .nuspec soubor, který se zobrazí v seznamu souborů každého balíčku. Tento soubor není nainstalován spolu s balíčkem v systému. Toto je manifest balíčku NuGet a můžete ho ignorovat.

  • Značky – *Tyto informace pocházejí z klíčového .TAGS slova v metadatech založených na komentářích souboru skriptu. Značky mají specifické požadavky a významy, které jsou popsány v části Podrobnosti o značkách .

  • Edice PowerShellu – u modulů určených pro PowerShell 5.0 a nižší je to řízeno pomocí značek. Pro Desktop použijte PSEdition_Desktop značky a jako jádro použijte značku PSEdition_Core. Pro moduly navržené pro PowerShell 5.1 a vyšší je v manifestu klíč CompatiblePSEditions . Další informace najdete v tématu Podpora PSEdition pro moduly.

  • Historie verzí – zobrazuje seznam verzí modulu, které byly publikovány v galerii. Balíčky skryté pomocí funkce Odstranit se v historii verzí nezobrazí, pokud nejste vlastníkem balíčku.

  • Web aplikace Project – Tyto informace pocházejí z klíčového .PROJECTURI slova v metadatech souboru skriptu založených na komentářích.

  • Licence – Tyto informace pocházejí z klíčového .LICENSEURI slova v metadatech souboru skriptu založených na komentářích.

    Důležité

    Pokud licence není poskytnuta prostřednictvím .LICENSEURI balíčku nebo v rámci balíčku, pak se na balíček vztahují Podmínky použití pro Galerie prostředí PowerShell. Další informace najdete v podmínkách použití.

  • Ikona – tato informace pochází z klíčového .ICONURI slova v metadatech souboru skriptu založených na komentářích. Identifikátor URI by měl odkazovat na obrázek 85 × 85 s průhledností pozadí. Identifikátor URI musí být přímým odkazem na soubor obrázku a nesmí přejít na webovou stránku nebo soubor v Galerie prostředí PowerShell balíčku.

Úprava podrobností balíčku

Stránka Galerie prostředí PowerShell Upravit balíček umožňuje vydavatelům změnit několik polí zobrazených pro balíček, konkrétně:

  • Nadpis
  • Popis
  • Souhrn
  • Adresa URL ikony
  • Adresa URL domovské stránky projektu
  • Autoři
  • Copyright
  • Značky
  • Poznámky k verzi
  • Vyžadovat licenci

Tyto informace byste měli upravovat jenom v galerii, abyste opravili to, co se zobrazuje ve starší verzi modulu. Uživatelům, kteří si balíček stáhlé, uvidí, že metadata neodpovídají Galerie prostředí PowerShell. Při každé změně informací v galerii byste měli publikovat novou verzi balíčku se stejnými změnami.

Podrobnosti značky

Značky jsou jednoduché řetězce, které spotřebitelé používají k vyhledání balíčků. Značky jsou nejužitečnější, když se používají konzistentně napříč souvisejícími balíčky. Použití variant stejného slova, například databáze a databáze nebo testování a testování, přináší jen malou výhodu. Značky jsou řetězce, které nerozlišují malá a velká písmena, a nemůžou obsahovat prázdné hodnoty. Pokud se domníváte, že uživatelé budou hledat nějakou frázi, přidejte ji do popisu balíčku, aby se našla ve výsledcích hledání. Pro zlepšení čitelnosti používejte písmena a písmena, pomlčky, podtržítka nebo tečky jazyka Pascal. Při vytváření dlouhých, složitých a neobvyklých značek, které jsou snadno chybně napsané, buďte opatrní.

Rutiny Galerie prostředí PowerShell a PowerShellGet mají pro PSEdition_Desktop značky a PSEdition_Core zvláštní význam. Podívejte se na předchozí diskuzi o edicích PowerShellu.

Jak jsme uvedli dříve, značky poskytují největší hodnotu, pokud jsou specifické a používají se konzistentně napříč mnoha balíčky. Jako vydavatel, který se snaží najít nejlepší značky k použití, je nejjednodušší vyhledat značky, které zvažujete, v Galerie prostředí PowerShell. V ideálním případě vrácené balíčky odpovídají vašemu použití tohoto klíčového slova.

Následující tabulka uvádí některé z nejčastěji používaných značek. Upřednostňovaná značka by měla vrátit nejlepší výsledky hledání.

Upřednostňovaná značka Alternativy a poznámky
ActiveDirectory Služba AD se aktuálně nepoužívá sama o sobě.
Appveyor
Automation
AWS
Azure
AzureAD
AzureAutomation
AzureRm Používá se primárně pro moduly AzureRM.
Backup
Sestavení
ChatOps
Cloud
Barva
Konfigurace
CrescendoBuilt Crescendo tuto značku přidá automaticky při exportu modulu.
Databáze Databáze (množné číslo) jsou méně žádoucí
DBA
Nasazení Nasazení se používá o něco méně často.
DevOps
DNS
Docker
DSC DesiredStateConfiguration je méně žádoucí, je příliš dlouhá.
DSCResource
DSCResourceKit
Excel
Výměna
Brána firewall
GIT
GitHubu
Gitlab
Google
HTML
Hyper-V Hyper-V je méně časté jako značka
IaaS
IIS
JSON
Linux
Protokol Upřednostňované použití protokolu jako věci
protokolování Upřednostňované použití protokolování jako akce
MacOS
Monitorování
MSI
Síť Sítě jsou podobné, méně často se používají
Office365 Vhodnější je kontrola pravopisu v Office. O365 se používá méně často, i když je kratší
PackageManagement
Otravovat
PoshBot
Sestava Sestava je věc
Generování sestav Vytváření sestav je akce, sestava je věc
Resourcemanager Arm se používá k popisu skupiny procesorů a neměl by se používat pro Azure Resource Manager
REST
Zabezpečení Obrana je méně přesná
SharePoint
SQL
Sqlserver
Storage
Test Testování je méně žádoucí
Ovládací prvek verze Verze je méně přesná, i když se používá častěji
VSTS
Windows
WinRM
Rozhraní WMI
ZIP